Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mdctags: init at unstable-2020-06-11 #107738

Merged
merged 1 commit into from Dec 28, 2020
Merged

Conversation

pacien
Copy link
Contributor

@pacien pacien commented Dec 27, 2020

Motivation for this change

This creates a package for mdctags, a ctags generator for markdown files.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
How to test

test.md:

# Some big title

## Some other title
nix-build -A mdctags && ./result/bin/mdctags test.md

This extracts ctags:

!_...
Some big title	/home/kea/src/nixpkgs/test.md	/^# Some big title$/;"	a	line:1	
Some other title	/home/kea/src/nixpkgs/test.md	/^## Some other title$/;"	b	line:3	h1:Some big title

The program can be used with the tagbar Vim plugin: https://github.com/wsdjeg/mdctags.rs#config-mdctags-for-tagbar
I'm using it and it's working fine so far.

Copy link
Member

@minijackson minijackson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Result of nix-review pr 107738 1

1 package were built:
  • mdctags

Runs fine with the provided example.

@SuperSandro2000
Copy link
Member

Result of nixpkgs-review pr 107738 run on x86_64-linux 1

1 package built:
  • mdctags

@SuperSandro2000
Copy link
Member

Result of nixpkgs-review pr 107738 run on x86_64-darwin 1

1 package built:
  • mdctags

@SuperSandro2000 SuperSandro2000 merged commit 405d762 into NixOS:master Dec 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants