├── .clog.toml
├── .gitignore
├── CHANGELOG.md
├── Cargo.toml
├── LICENSE
├── README.md
├── _
├── bashdocrc.toml
├── cli.yml
├── example
    ├── html.png
    ├── zshrc
    └── zshrc.png
├── src
    ├── docs.rs
    └── main.rs
└── static
    └── template.hbs


/.clog.toml:
--------------------------------------------------------------------------------
 1 | [clog]
 2 | # A repository link with the trailing '.git' which will be used to generate
 3 | # all commit and issue links
 4 | repository = "https://github.com/dustinknopoff/bashdoc"
 5 | # A constant release title
 6 | subtitle = "Bashdoc"
 7 | 
 8 | # specify the style of commit links to generate, defaults to "github" if omitted
 9 | link-style = "github"
10 | 
11 | # The preferred way to set a constant changelog. This file will be read for old changelog
12 | # data, then prepended to for new changelog data. It's the equivilant to setting
13 | # both infile and outfile to the same file.
14 | #
15 | # Do not use with outfile or infile fields!
16 | #
17 | # Defaults to stdout when omitted
18 | changelog = "CHANGELOG.md"


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | 
  2 | # Created by https://www.gitignore.io/api/vim,visualstudiocode,mac,rust,jetbrains+all
  3 | # Edit at https://www.gitignore.io/?templates=vim,visualstudiocode,mac,rust,jetbrains+all
  4 | 
  5 | ### JetBrains+all ###
  6 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
  7 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
  8 | 
  9 | # User-specific stuff
 10 | .idea/**/workspace.xml
 11 | .idea/**/tasks.xml
 12 | .idea/**/usage.statistics.xml
 13 | .idea/**/dictionaries
 14 | .idea/**/shelf
 15 | 
 16 | # Generated files
 17 | .idea/**/contentModel.xml
 18 | 
 19 | # Sensitive or high-churn files
 20 | .idea/**/dataSources/
 21 | .idea/**/dataSources.ids
 22 | .idea/**/dataSources.local.xml
 23 | .idea/**/sqlDataSources.xml
 24 | .idea/**/dynamic.xml
 25 | .idea/**/uiDesigner.xml
 26 | .idea/**/dbnavigator.xml
 27 | 
 28 | # Gradle
 29 | .idea/**/gradle.xml
 30 | .idea/**/libraries
 31 | 
 32 | # Gradle and Maven with auto-import
 33 | # When using Gradle or Maven with auto-import, you should exclude module files,
 34 | # since they will be recreated, and may cause churn.  Uncomment if using
 35 | # auto-import.
 36 | # .idea/modules.xml
 37 | # .idea/*.iml
 38 | # .idea/modules
 39 | 
 40 | # CMake
 41 | cmake-build-*/
 42 | 
 43 | # Mongo Explorer plugin
 44 | .idea/**/mongoSettings.xml
 45 | 
 46 | # File-based project format
 47 | *.iws
 48 | 
 49 | # IntelliJ
 50 | out/
 51 | 
 52 | # mpeltonen/sbt-idea plugin
 53 | .idea_modules/
 54 | 
 55 | # JIRA plugin
 56 | atlassian-ide-plugin.xml
 57 | 
 58 | # Cursive Clojure plugin
 59 | .idea/replstate.xml
 60 | 
 61 | # Crashlytics plugin (for Android Studio and IntelliJ)
 62 | com_crashlytics_export_strings.xml
 63 | crashlytics.properties
 64 | crashlytics-build.properties
 65 | fabric.properties
 66 | 
 67 | # Editor-based Rest Client
 68 | .idea/httpRequests
 69 | 
 70 | # Android studio 3.1+ serialized cache file
 71 | .idea/caches/build_file_checksums.ser
 72 | 
 73 | ### JetBrains+all Patch ###
 74 | # Ignores the whole .idea folder and all .iml files
 75 | # See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
 76 | 
 77 | .idea/
 78 | 
 79 | # Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
 80 | 
 81 | *.iml
 82 | modules.xml
 83 | .idea/misc.xml
 84 | *.ipr
 85 | 
 86 | #!! ERROR: mac is undefined. Use list command to see defined gitignore types !!#
 87 | 
 88 | ### Rust ###
 89 | # Generated by Cargo
 90 | # will have compiled files and executables
 91 | /target/
 92 | 
 93 | # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 94 | # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
 95 | Cargo.lock
 96 | 
 97 | # These are backup files generated by rustfmt
 98 | **/*.rs.bk
 99 | 
100 | ### Vim ###
101 | # Swap
102 | [._]*.s[a-v][a-z]
103 | [._]*.sw[a-p]
104 | [._]s[a-rt-v][a-z]
105 | [._]ss[a-gi-z]
106 | [._]sw[a-p]
107 | 
108 | # Session
109 | Session.vim
110 | 
111 | # Temporary
112 | .netrwhist
113 | *~
114 | # Auto-generated tag files
115 | tags
116 | # Persistent undo
117 | [._]*.un~
118 | 
119 | ### VisualStudioCode ###
120 | .vscode/*
121 | !.vscode/settings.json
122 | !.vscode/tasks.json
123 | !.vscode/launch.json
124 | !.vscode/extensions.json
125 | 
126 | ### VisualStudioCode Patch ###
127 | # Ignore all local history of files
128 | .history
129 | 
130 | # End of https://www.gitignore.io/api/vim,visualstudiocode,mac,rust,jetbrains+all
131 | 
132 | # Created by https://www.gitignore.io/api/macos
133 | # Edit at https://www.gitignore.io/?templates=macos
134 | 
135 | ### macOS ###
136 | # General
137 | .DS_Store
138 | .AppleDouble
139 | .LSOverride
140 | 
141 | # Icon must end with two \r
142 | Icon
143 | 
144 | # Thumbnails
145 | ._*
146 | 
147 | # Files that might appear in the root of a volume
148 | .DocumentRevisions-V100
149 | .fseventsd
150 | .Spotlight-V100
151 | .TemporaryItems
152 | .Trashes
153 | .VolumeIcon.icns
154 | .com.apple.timemachine.donotpresent
155 | 
156 | # Directories potentially created on remote AFP share
157 | .AppleDB
158 | .AppleDesktop
159 | Network Trash Folder
160 | Temporary Items
161 | .apdisk
162 | 
163 | # End of https://www.gitignore.io/api/macos
164 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | <a name=""></a>
 2 | 
 3 | ## Bashdoc (2018-12-25)
 4 | 
 5 | #### Performance
 6 | 
 7 | - **generate_doc_file:** Parallelize Doc generation ([984e546e](https://github.com/dustinknopoff/bashdoc/commit/984e546e19aed5aec4ad91d6cf4b506b03c31d42))
 8 | 
 9 | #### Bug Fixes
10 | 
11 | - **0.4.0:** ([31d2454b](https://github.com/dustinknopoff/bashdoc/commit/31d2454bcb44a074c2b22e1c58ff38a64f78a830))
12 | - **All:** Apply clippy fixes ([bca0b613](https://github.com/dustinknopoff/bashdoc/commit/bca0b613adc82452bfb3c70cfe15c205d5b74816))
13 | - **Cargo.toml:**
14 |   - version bump for cargo ([b7b5e624](https://github.com/dustinknopoff/bashdoc/commit/b7b5e62481ff4e448a7d49c12321e941beeced6c))
15 |   - Version bump to update cargo ([0bbd48aa](https://github.com/dustinknopoff/bashdoc/commit/0bbd48aab4500b2b6ee81f39c63453a745231db0))
16 |   - Experimental badge ([075a9d68](https://github.com/dustinknopoff/bashdoc/commit/075a9d68be855ced117cf1f60b30629c2b408488))
17 |   - Metadata for publishing added ([8fda35d6](https://github.com/dustinknopoff/bashdoc/commit/8fda35d68637380499b8aaf515570bc7e41cafc3))
18 |   - Remove email ([29d67053](https://github.com/dustinknopoff/bashdoc/commit/29d67053bb62e31458a9be9635b6fdb078f52639))
19 | - **Clippy:** Allow Cyclomatic Complexity on nom parser ([6ce68ec9](https://github.com/dustinknopoff/bashdoc/commit/6ce68ec90e0525977b716ce579a24d64b491ca33))
20 | - **Delimiters:** descriptors can split on things other than whitespace ([15c704b9](https://github.com/dustinknopoff/bashdoc/commit/15c704b97754314f1577a1d7f1630bd2bfa2174e))
21 | - **Docs:** Better md formatting ([8d4df95b](https://github.com/dustinknopoff/bashdoc/commit/8d4df95b3759f9ec9472c7322f3229f297fae22f))
22 | - **README:**
23 |   - include cargo install instructions ([5c504667](https://github.com/dustinknopoff/bashdoc/commit/5c5046676c2842a7dbcaedc80f47c1b1a365039c))
24 |   - code blocks should be highlighted for bash not rust ([62db2ad2](https://github.com/dustinknopoff/bashdoc/commit/62db2ad2f253c25517268ff7ead595f4c73f063d))
25 | - **Support windows again:** ([46f6267a](https://github.com/dustinknopoff/bashdoc/commit/46f6267a074f0024c960d29d5e92ce0fd76848a1))
26 | - **Watcher:** Better information on watching files ([fbde071d](https://github.com/dustinknopoff/bashdoc/commit/fbde071d0d578bfa0d64e73984593ab5a200a368))
27 | - **Windows:** only replace ~ with home_dir if ~ in path ([b192b8a0](https://github.com/dustinknopoff/bashdoc/commit/b192b8a01bec0b85a0762b4ac52d3b92ebf2068f))
28 | - **Windows support re-added:** ([ca69c443](https://github.com/dustinknopoff/bashdoc/commit/ca69c443acd035bb6b7a3e6df7a975a9908c4f42))
29 | - **cargo.toml:** Specify files to package ([6d99b502](https://github.com/dustinknopoff/bashdoc/commit/6d99b502cb08b108b80b907d618c4bc13326f528))
30 | - **cli:** Removed requirement for `--location` on all calls ([e93d9144](https://github.com/dustinknopoff/bashdoc/commit/e93d9144979bffe8c36dffc1199cf8805752ee7e))
31 | - **cli.yml:** Keep version numbers consistent ([0347fd80](https://github.com/dustinknopoff/bashdoc/commit/0347fd804d36cd9c39debcd50fb9878d763b96fc))
32 | - **clippy:** implement clippy suggestions ([4f59d771](https://github.com/dustinknopoff/bashdoc/commit/4f59d7713ad4de2abb9188b63c6a2569d678b927))
33 | - **delimiters:** Resolves iisue where user with no BASHDOC_CONFIG_PATH caused a panic ([8738852d](https://github.com/dustinknopoff/bashdoc/commit/8738852d8acc453b3ee1947da3f7b18fdc147a72))
34 | - **demo:** remove old examples ([dea6213a](https://github.com/dustinknopoff/bashdoc/commit/dea6213abb5eec5165504b3bd0dab183e879e2ba))
35 | - **docs.rs:** Remove debug printlns ([50b35b08](https://github.com/dustinknopoff/bashdoc/commit/50b35b08d64c06800359babb5823e7af7e94782f))
36 | - **example:**
37 |   - weird coloring ([bb2be77c](https://github.com/dustinknopoff/bashdoc/commit/bb2be77cfa59527ec595abdc24d035f3f34c048d))
38 |   - fixes ([bd1d76bd](https://github.com/dustinknopoff/bashdoc/commit/bd1d76bdac0fb0ebd9c3ea2d770eadfcb8f19002))
39 | - **header:** Improved header looks ([b8f5433c](https://github.com/dustinknopoff/bashdoc/commit/b8f5433c2100d2172699cc32606b4bd15eaea96c))
40 | - **html:** remove example html to stop inflation of html in repo ([e9965c58](https://github.com/dustinknopoff/bashdoc/commit/e9965c58df218db21b6fe04d05748a10d132d334))
41 | - **screenshot:** ([87d31b24](https://github.com/dustinknopoff/bashdoc/commit/87d31b2469614f92ca1a42fa81d08d590692a610))
42 | - **static:** remove unnecessary CSS files ([38b6f064](https://github.com/dustinknopoff/bashdoc/commit/38b6f06476e8ecaba05c497cda3022bec6fa8d5d))
43 | 
44 | #### Features
45 | 
46 | - **Delimiters:** override global .bashdocrc within a directory ([45517f6d](https://github.com/dustinknopoff/bashdoc/commit/45517f6d7b2be21d3510c4c008cc63ea99653c12))
47 | - **Extracted:** Parsing of bashdocs from text now includes the line number of the function extract ([0ce89d6e](https://github.com/dustinknopoff/bashdoc/commit/0ce89d6e65efd4852b79aecf89a37d746922f4bf))
48 | - **Windows:** support for windows filepaths ([fec2de62](https://github.com/dustinknopoff/bashdoc/commit/fec2de6235b82c18ebaf839aa0e736196850ab40))
49 | - **cli.yml:** Can provide a custom template for html documentation ([05936821](https://github.com/dustinknopoff/bashdoc/commit/059368217d8f155662a1ee3e156d0e0e373c2c03), breaks [#](https://github.com/dustinknopoff/bashdoc/issues/))
50 | - **docs.rs:** Upgrade to 2018 edition, move to nom for parsing ([e7b0541b](https://github.com/dustinknopoff/bashdoc/commit/e7b0541b5fe26db23198e15100916f0d59fbeeae))
51 | - **output HTML:**
52 |   - Basic example of outputting html documentation of a bashdoc call ([0155a3e8](https://github.com/dustinknopoff/bashdoc/commit/0155a3e84058b2378b8c0dfc7b37e62c2a3bda7e))
53 |   - Extremely bare example of creating html documentation from a bashdoc call ([030645ef](https://github.com/dustinknopoff/bashdoc/commit/030645ef8fc1c2d66e4095c14146c6ac9f6ec8d7))
54 | - **script.js:**
55 |   - Highlight clicked on function ([5bab275c](https://github.com/dustinknopoff/bashdoc/commit/5bab275cf8fb291934122d7bc9520733530a775b))
56 |   - Highlight clicked on function ([b8d25409](https://github.com/dustinknopoff/bashdoc/commit/b8d25409d328ad1d282ba45c58b3a19f0630166b))
57 | 
58 | #### Breaking Changes
59 | 
60 | - **cli.yml:** Can provide a custom template for html documentation ([05936821](https://github.com/dustinknopoff/bashdoc/commit/059368217d8f155662a1ee3e156d0e0e373c2c03), breaks [#](https://github.com/dustinknopoff/bashdoc/issues/))
61 | 


--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
 1 | [package]
 2 | name = "bashdoc"
 3 | version = "0.6.0"
 4 | authors = ["Dustin Knopoff <dustinknopoff@gmail.com>"]
 5 | description = """
 6 | A tool for generating documentation/help menu for user defined bash functions.
 7 | """
 8 | edition = "2018"
 9 | homepage = "https://github.com/dustinknopoff/bashdoc"
10 | repository = "https://github.com/dustinknopoff/bashdoc"
11 | documentation = "https://docs.rs/crate/bashdoc"
12 | readme = "README.md"
13 | keywords = ["bash", "docs", "documentation"]
14 | categories = ["command-line-utilities", "text-processing"]
15 | license = "MIT"
16 | exclude = ["example/**", ".idea/**", "backdocrc.toml", ".clog.toml"]
17 | 
18 | [badges]
19 | maintenance = { status = "experimental" }
20 | 
21 | [dependencies]
22 | colored = "1.7.0"
23 | dirs = "1.0.4"
24 | clap = { version = "2.32.0", features = ["yaml"] }
25 | glob = "0.2.11"
26 | rayon = "1.0.3"
27 | serde = { version = "1.0.87", features = ["derive"] }
28 | serde_json = "1.0.38"
29 | toml = "0.4.10"
30 | nom = "4.2.0"
31 | handlebars = "1.1.0"
32 | notify = "4.0.9"
33 | nom_locate = "0.3.1"
34 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2018 Dustin Knopoff
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # bashdoc
  2 | 
  3 | ## BashDoc
  4 | 
  5 | A tool for generating documentation/help menu for ~~user defined bash functions~~ any folder or file with 6 generic delimiters defined.
  6 | 
  7 | ### Syntax
  8 | 
  9 | #### Example
 10 | 
 11 | Using syntax similar to below
 12 | 
 13 | ```bash
 14 | #;
 15 | # cd()
 16 | # moves to given directory
 17 | # @param directory: folder to move to
 18 | # @return void
 19 | #"
 20 | cd() {
 21 |    cd $1
 22 | }
 23 | ```
 24 | 
 25 | on my `zshrc` Outputs
 26 | 
 27 | ![](https://github.com/dustinknopoff/bashdoc/raw/master/example/zshrc.png)
 28 | 
 29 | with lots of color!
 30 | 
 31 | #### Global Delimiters
 32 | 
 33 | The default delimiters to use are as follows:
 34 | 
 35 | `START_DELIM = #;`
 36 | 
 37 | `END_DELIM = #"`
 38 | 
 39 | `PAR_DELIM = @param`
 40 | 
 41 | `RET_DELIM = @return`
 42 | 
 43 | `OPT_DELIM = # -`
 44 | 
 45 | `COMM_DELIM = #`
 46 | 
 47 | These can be modifed in your `.bashdocrc`.
 48 | 
 49 | ### Install
 50 | 
 51 | ```bash
 52 | cargo install bashdoc
 53 | ```
 54 | 
 55 | or from source
 56 | 
 57 | **NOTE: Must use Rust 2018 Edition**
 58 | 
 59 | _update with `rustup update stable`_
 60 | 
 61 | ```bash
 62 | git clone https://github.com/dustinknopoff/bashdoc
 63 | cd bashdoc
 64 | cargo install --path . --force
 65 | ```
 66 | 
 67 | ### Usage
 68 | 
 69 | ```bash
 70 | bashdoc 0.4.10
 71 | Creates a "javadoc" like structure for bash. See github repo github.com/dustinknopoff/bashdoc for information on formatting.
 72 | 
 73 | USAGE:
 74 | bashdoc [FLAGS] [OPTIONS] <INPUT> [SUBCOMMAND]
 75 | 
 76 | FLAGS:
 77 | -c, --color      toggles color
 78 | -h, --help       Prints help information
 79 | -V, --version    Prints version information
 80 | -w, --watch      continuously update on change
 81 | 
 82 | OPTIONS:
 83 | -j, --json <FILE>            print result as JSON
 84 | -l, --location <location>    location to save HTML
 85 | -t, --template <template>    .hbs template to use for generation of documentation
 86 | 
 87 | ARGS:
 88 | <INPUT>    Sets the input file or glob pattern to use
 89 | 
 90 | SUBCOMMANDS:
 91 | help        Prints this message or the help of the given subcommand(s)
 92 | override    override the delimiters
 93 | ```
 94 | 
 95 | See the [examples](https://github.com/dustinknopoff/bashdoc/tree/master/example) folder for more.
 96 | 
 97 | See the [changelog](https://github.com/dustinknopoff/bashdoc/blob/master/CHANGELOG.md) for updates
 98 | 
 99 | ## Changelog
100 | 
101 | - v0.4.0 - Added to crates.io
102 | - v0.4.1/v0.4.2 - Better descriptions for crates.io
103 | - v.0.4.5 - Fix error where bashdoc would not function for users without a `~/.bashdocrc`
104 | - v.0.4.6 - Improved Error handling, `--html` argument removed replaced with `--location`, `--template` argument added for supplying custom `.hbs`
105 | - v0.4.7 - Fix required location for all inputs and not exclusive to `--location`
106 | - v0.4.8 - Clearer README, link to docs.rs documentation
107 | - v0.4.9 - Improved error path handling
108 | - v0.4.10 - Support for windows file paths again
109 | - v0.4.11 - support for overriding global `.bashdocrc` within a directory.
110 | - v0.4.12 - descriptors can be split on ':' or whitespace
111 | - v0.5.0 - refactor for improved error handling/rust-ic code
112 | 
113 | License: MIT
114 | 


--------------------------------------------------------------------------------
/_:
--------------------------------------------------------------------------------
  1 | {
  2 |   "docs": [
  3 |     {
  4 |       "thedocs": [
  5 |         {
  6 |           "short_description": "sourcez",
  7 |           "long_description": "re-initialize .zshrc file",
  8 |           "descriptors": [],
  9 |           "params": [],
 10 |           "returns": [],
 11 |           "position": 26
 12 |         },
 13 |         {
 14 |           "short_description": "zshconfig",
 15 |           "long_description": "open .zshrc in VSCode",
 16 |           "descriptors": [],
 17 |           "params": [],
 18 |           "returns": [],
 19 |           "position": 32
 20 |         },
 21 |         {
 22 |           "short_description": "vimconfig",
 23 |           "long_description": "open .vimrc in vim",
 24 |           "descriptors": [],
 25 |           "params": [],
 26 |           "returns": [],
 27 |           "position": 38
 28 |         },
 29 |         {
 30 |           "short_description": "docs",
 31 |           "long_description": "shortcut to ~/Documents folder",
 32 |           "descriptors": [],
 33 |           "params": [],
 34 |           "returns": [],
 35 |           "position": 47
 36 |         },
 37 |         {
 38 |           "short_description": "svenv",
 39 |           "long_description": "activate virtual python environment",
 40 |           "descriptors": [],
 41 |           "params": [],
 42 |           "returns": [],
 43 |           "position": 53
 44 |         },
 45 |         {
 46 |           "short_description": "update",
 47 |           "long_description": "update Operating System, Brew, NPM, Applications, and Pip",
 48 |           "descriptors": [],
 49 |           "params": [],
 50 |           "returns": [],
 51 |           "position": 63
 52 |         },
 53 |         {
 54 |           "short_description": "cleanup",
 55 |           "long_description": "remove .DS_Store files from current directory",
 56 |           "descriptors": [],
 57 |           "params": [],
 58 |           "returns": [],
 59 |           "position": 69
 60 |         },
 61 |         {
 62 |           "short_description": "emptytrash",
 63 |           "long_description": "clean the trash",
 64 |           "descriptors": [],
 65 |           "params": [],
 66 |           "returns": [],
 67 |           "position": 75
 68 |         },
 69 |         {
 70 |           "short_description": "helpme",
 71 |           "long_description": "access cht.sh for help with commands and languages",
 72 |           "descriptors": [],
 73 |           "params": [],
 74 |           "returns": [],
 75 |           "position": 82
 76 |         },
 77 |         {
 78 |           "short_description": "cloud",
 79 |           "long_description": "shortcut to iCloud documents",
 80 |           "descriptors": [],
 81 |           "params": [],
 82 |           "returns": [],
 83 |           "position": 88
 84 |         },
 85 |         {
 86 |           "short_description": "notes",
 87 |           "long_description": "shortcut to exported Notes",
 88 |           "descriptors": [],
 89 |           "params": [],
 90 |           "returns": [],
 91 |           "position": 94
 92 |         },
 93 |         {
 94 |           "short_description": "gits",
 95 |           "long_description": "Shortcut to ~/Documents/Gits",
 96 |           "descriptors": [],
 97 |           "params": [],
 98 |           "returns": [],
 99 |           "position": 100
100 |         },
101 |         {
102 |           "short_description": "glsnips()",
103 |           "long_description": "Display descriptions of all Dash Snippets",
104 |           "descriptors": [],
105 |           "params": [
106 |             {
107 |               "key": "filter",
108 |               "value": "Optional keyword to fuzzy search"
109 |             }
110 |           ],
111 |           "returns": [],
112 |           "position": 125
113 |         },
114 |         {
115 |           "short_description": "bip()",
116 |           "long_description": "Fuzzy search brew",
117 |           "descriptors": [],
118 |           "params": [],
119 |           "returns": [],
120 |           "position": 151
121 |         },
122 |         {
123 |           "short_description": "allgits()",
124 |           "long_description": "Git add, commit, and push",
125 |           "descriptors": [],
126 |           "params": [
127 |             {
128 |               "key": "msg",
129 |               "value": "commit message"
130 |             }
131 |           ],
132 |           "returns": [],
133 |           "position": 166
134 |         },
135 |         {
136 |           "short_description": "xi()",
137 |           "long_description": "Open a document in Xi",
138 |           "descriptors": [],
139 |           "params": [
140 |             {
141 |               "key": "path",
142 |               "value": "file path to open"
143 |             }
144 |           ],
145 |           "returns": [],
146 |           "position": 175
147 |         },
148 |         {
149 |           "short_description": "fs()",
150 |           "long_description": "Fuzzy file and directory search",
151 |           "descriptors": [
152 |             {
153 |               "key": "CTRL-O",
154 |               "value": "to open with `open` command,"
155 |             },
156 |             {
157 |               "key": "CTRL-E",
158 |               "value": "or Enter key to open with the $EDITOR"
159 |             },
160 |             {
161 |               "key": "CTRL-S",
162 |               "value": "to search inside files"
163 |             },
164 |             {
165 |               "key": "CTRL-C",
166 |               "value": "to copy file path to clipboard"
167 |             },
168 |             {
169 |               "key": "CTRL-D",
170 |               "value": "to cd to directory of file"
171 |             },
172 |             {
173 |               "key": "CTRL-N",
174 |               "value": "to make a new markdown file."
175 |             }
176 |           ],
177 |           "params": [],
178 |           "returns": [],
179 |           "position": 200
180 |         },
181 |         {
182 |           "short_description": "2mp4()",
183 |           "long_description": "Convert from gif or webm to mp4 for all in current directory",
184 |           "descriptors": [],
185 |           "params": [
186 |             {
187 |               "key": "type",
188 |               "value": "mp4 or gif"
189 |             }
190 |           ],
191 |           "returns": [],
192 |           "position": 246
193 |         },
194 |         {
195 |           "short_description": "gitrm()",
196 |           "long_description": "Remove an unwanted watched folder",
197 |           "descriptors": [],
198 |           "params": [
199 |             {
200 |               "key": "filename",
201 |               "value": "file type to be removed from this folder"
202 |             }
203 |           ],
204 |           "returns": [],
205 |           "position": 263
206 |         },
207 |         {
208 |           "short_description": "pygnore()",
209 |           "long_description": "Generate a .gitignore file for python projects",
210 |           "descriptors": [],
211 |           "params": [],
212 |           "returns": [],
213 |           "position": 272
214 |         },
215 |         {
216 |           "short_description": "fbr()",
217 |           "long_description": "Fuzzy search git branches",
218 |           "descriptors": [],
219 |           "params": [],
220 |           "returns": [],
221 |           "position": 281
222 |         },
223 |         {
224 |           "short_description": "fshow()",
225 |           "long_description": "Preview git tree",
226 |           "descriptors": [],
227 |           "params": [],
228 |           "returns": [],
229 |           "position": 294
230 |         },
231 |         {
232 |           "short_description": "fstat()",
233 |           "long_description": "Show uncommitted files",
234 |           "descriptors": [],
235 |           "params": [],
236 |           "returns": [],
237 |           "position": 311
238 |         },
239 |         {
240 |           "short_description": "gi()",
241 |           "long_description": ".gitignore file generator",
242 |           "descriptors": [],
243 |           "params": [
244 |             {
245 |               "key": "list",
246 |               "value": "list of types to generator gitignore of"
247 |             }
248 |           ],
249 |           "returns": [],
250 |           "position": 333
251 |         },
252 |         {
253 |           "short_description": "setgit()",
254 |           "long_description": "Initialize a git directory",
255 |           "descriptors": [],
256 |           "params": [
257 |             {
258 |               "key": "giturl",
259 |               "value": "url of git repo push to"
260 |             }
261 |           ],
262 |           "returns": [],
263 |           "position": 343
264 |         },
265 |         {
266 |           "short_description": "gup()",
267 |           "long_description": "set up stream of passed in branch to origin",
268 |           "descriptors": [],
269 |           "params": [
270 |             {
271 |               "key": "branch",
272 |               "value": "name of branch"
273 |             }
274 |           ],
275 |           "returns": [],
276 |           "position": 352
277 |         },
278 |         {
279 |           "short_description": "psman()",
280 |           "long_description": "Open man page in Preview.app",
281 |           "descriptors": [],
282 |           "params": [
283 |             {
284 |               "key": "cli",
285 |               "value": "command line function to call man on"
286 |             }
287 |           ],
288 |           "returns": [],
289 |           "position": 362
290 |         }
291 |       ],
292 |       "filename": "zshrc"
293 |     }
294 |   ]
295 | }


--------------------------------------------------------------------------------
/bashdocrc.toml:
--------------------------------------------------------------------------------
1 | start = "#;"
2 | end = "#\""
3 | params = "@param"
4 | ret = "@return"
5 | opt = "# -"
6 | comm = "# "


--------------------------------------------------------------------------------
/cli.yml:
--------------------------------------------------------------------------------
 1 | about: 'Creates a "javadoc" like structure for bash. See github repo github.com/dustinknopoff/bashdoc for information on formatting.'
 2 | name: bashdoc
 3 | version: "0.5.1"
 4 | args:
 5 |   - color:
 6 |       help: "toggles color"
 7 |       long: color
 8 |       short: c
 9 |   - INPUT:
10 |       help: "Sets the input file or glob pattern to use"
11 |       index: 1
12 |       required: true
13 |   - json:
14 |       help: "print result as JSON"
15 |       long: json
16 |       short: j
17 |       takes_value: true
18 |       value_name: FILE
19 |   - watch:
20 |       help: continuously update on change
21 |       short: w
22 |       long: watch
23 |   - location:
24 |       short: l
25 |       long: location
26 |       help: location to save HTML
27 |       takes_value: true
28 |   - template:
29 |       short: t
30 |       long: template
31 |       help: .hbs template to use for generation of documentation
32 |       takes_value: true
33 |       requires: location
34 | subcommands:
35 |   - override:
36 |       about: override the delimiters
37 |       args:
38 |         - start:
39 |             short: s
40 |             long: start
41 |             help: delimiter for start
42 |             takes_value: true
43 |         - end:
44 |             short: e
45 |             long: end
46 |             help: delimiter for start
47 |             takes_value: true
48 |         - descriptor:
49 |             short: d
50 |             long: desc
51 |             help: delimiter for descriptors
52 |             takes_value: true
53 |         - params:
54 |             short: p
55 |             long: param
56 |             help: delimiter for parameters
57 |             takes_value: true
58 |         - returns:
59 |             short: r
60 |             long: ret
61 |             help: delimiter for return values
62 |             takes_value: true
63 |         - comment:
64 |             short: c
65 |             long: comment
66 |             help: delimiter for comments
67 |             takes_value: true
68 | 


--------------------------------------------------------------------------------
/example/html.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dustinknopoff/bashdoc/0ebc6d2ef615818c30b14d1ea0644664a9e872bb/example/html.png


--------------------------------------------------------------------------------
/example/zshrc:
--------------------------------------------------------------------------------
  1 | # EXPORTS
  2 | # If you come from bash you might have to change your $PATH.
  3 | export PATH=$HOME/bin:/usr/local/bin:$PATH
  4 | # Path to your oh-my-zsh installation.
  5 | export ZSH=$HOME/.oh-my-zsh
  6 | export RIPGREP_CONFIG_PATH="${HOME}/.ripgreprc"
  7 | export BASHDOC_CONFIG_PATH="${HOME}/.bashdocrc"
  8 | export PATH="$PATH:$HOME/.scripts"
  9 | export RUST_BACKTRACE=1
 10 | # source /home/Dustin/.bash_profile
 11 | # Preferred editor for local and remote sessions
 12 | if [[ -n $SSH_CONNECTION ]]; then
 13 |   export EDITOR='vim'
 14 | else
 15 |   export EDITOR='code'
 16 | fi
 17 | 
 18 | export PATH="/user/local/bin:$PATH"
 19 | 
 20 | # ALIASES
 21 | ## re-initialize .zshrc file
 22 | #;
 23 | # sourcez
 24 | # re-initialize .zshrc file
 25 | #"
 26 | alias sourcez="source ~/.zshrc" 
 27 | ## open .zshrc in VSCode
 28 | #;
 29 | # zshconfig
 30 | # open .zshrc in VSCode
 31 | #"
 32 | alias zshconfig="code ~/.zshrc"
 33 | ## open .vimrc in vim
 34 | #;
 35 | # vimconfig
 36 | # open .vimrc in vim
 37 | #"
 38 | alias vimconfig="vim ~/.vimrc"
 39 | 
 40 | alias serve='python3.6 -m http.server' #start a little server
 41 | eval $(thefuck --alias) #make The Fuck work
 42 | ## shortcut to ~/Documents folder
 43 | #;
 44 | # docs
 45 | # shortcut to ~/Documents folder
 46 | #"
 47 | alias docs='cd ~/Documents' #shortcut to go to Documents folder
 48 | ## activate virtual python environment
 49 | #;
 50 | # svenv
 51 | # activate virtual python environment
 52 | #"
 53 | alias svenv='source venv/bin/activate' #shortcut to activate venv
 54 | # alias ls="command ls ${colorflag}"
 55 | # alias grep='grep --color=auto'
 56 | # alias fgrep='fgrep --color=auto'
 57 | # alias egrep='egrep --color=auto'
 58 | ## update Operating System, Brew, NPM, Applications, and Pip
 59 | #;
 60 | # update
 61 | # update Operating System, Brew, NPM, Applications, and Pip
 62 | #"
 63 | alias update='sudo softwareupdate -i -a; brew update; brew upgrade; brew cleanup; npm install npm -g; npm update -g; mas upgrade; brew cask upgrade;' #update everything
 64 | ## remove .DS_Store files from current directory
 65 | #;
 66 | # cleanup
 67 | # remove .DS_Store files from current directory
 68 | #"
 69 | alias cleanup="find . -type f -name '*.DS_Store' -ls -delete" #get rid of .DS_Store
 70 | ## clean the trash
 71 | #;
 72 | # emptytrash
 73 | # clean the trash
 74 | #"
 75 | alias emptytrash="sudo rm -rfv /Volumes/*/.Trashes; sudo rm -rfv ~/.Trash; sudo rm -rfv /private/var/log/asl/*.asl; sqlite3 ~/Library/Preferences/com.apple.LaunchServices.QuarantineEventsV* 'delete from LSQuarantineEvent'" #update everything
 76 | # alias ccat='pygmentize -g'
 77 | ## access cht.sh for help with commands and languages
 78 | #;
 79 | # helpme
 80 | # access cht.sh for help with commands and languages
 81 | #"
 82 | alias helpme='cht.sh' #get help with commands and languages
 83 | ## shortcut to iCloud documents
 84 | #;
 85 | # cloud
 86 | # shortcut to iCloud documents
 87 | #"
 88 | alias cloud='cd ~/Library/Mobile\ Documents/com\~apple\~CloudDocs' #shortcut to iCloud
 89 | ## shortcut to exported Notes
 90 | #;
 91 | # notes
 92 | # shortcut to exported Notes
 93 | #"
 94 | alias notes='cd ~/Library/Mobile\ Documents/com\~apple\~CloudDocs/Notes' #shortcut to Bear Notes in iCloud
 95 | ## Shortcut to ~/Documents/Gits
 96 | #;
 97 | # gits
 98 | # Shortcut to ~/Documents/Gits
 99 | #"
100 | alias gits='cd ~/Documents/Gits' #shortcut to folder containing git controlled directories
101 | 
102 | function myhelp() {
103 |     if [ -z "$1" ];
104 |     then
105 |     bashdoc ~/.zshrc -c
106 |   else
107 |     bashdoc ~/.zshrc | sed 's/:.*$//g' | fzf --query="$1" --height 40% | xargs -0 -I {} /bin/zsh -c 'source ~/.zshrc; {}'
108 |   fi
109 | }
110 | 
111 | function vimhelp() {
112 |       if [ -z "$1" ];
113 |     then
114 |     bashdoc ~/.vimrc -o "\"; \"\" @param @return \"- \"" -c
115 |   else
116 |    bashdoc ~/.vimrc -o "\"; \"\" @param @return \"- \"" | sed 's/:.*$//g'| fzf --query="$1" --height 40%
117 |   fi
118 | }
119 | 
120 | #;
121 | # glsnips()
122 | # Display descriptions of all Dash Snippets
123 | # @param filter: Optional keyword to fuzzy search
124 | #"
125 | function glsnips() {
126 |       if [ -z "$1" ];
127 |     then
128 |     bashdoc ~/.dash-snippets -c
129 |   else
130 |     bashdoc ~/.dash-snippets | fzf --query="$1" --height 40% | sed 's/:.*$//g' | xargs -0 -I {} /bin/zsh -c 'source ~/.zshrc; {}'
131 |   fi
132 | }
133 | 
134 | # METHODS
135 | # Syntax highlighted cat
136 | # ccat() {
137 | #   file=$1
138 | #   if [[ $file == *.md ]]; then
139 | #     mdv $file
140 | #   else
141 | #     pygmentize -g $file
142 | #   fi
143 | # }
144 | 
145 | ##  Fuzzy search brew
146 | #;
147 | # bip()
148 | # Fuzzy search brew
149 | # 
150 | #"
151 | function bip() {
152 |   local inst=$(brew search | fzf -m)
153 | 
154 |   if [[ $inst ]]; then
155 |     for prog in $(echo $inst);
156 |     do; brew install $prog; done;
157 |   fi
158 | }
159 | 
160 | ## Git add, commit, and push
161 | #;
162 | # allgits()
163 | # Git add, commit, and push
164 | # @param msg: commit message
165 | #"
166 | function allgits() {
167 |   gaa;git cz -a; git push
168 | }
169 | 
170 | #;
171 | # xi()
172 | # Open a document in Xi
173 | # @param path: file path to open
174 | #"
175 | function xi() {
176 |   if [ -f "$1" ]; then 
177 |   open -a XiEditor "$1"
178 |   else
179 |   touch "$1"
180 |   open -a XiEditor "$1"
181 |   fi
182 | }
183 | 
184 | # helpme() {
185 | #   where=$1
186 | #   nospace=${where// /+}
187 | #   curl cht.sh/$nospace
188 | # }
189 | 
190 | #;
191 | # fs()
192 | # Fuzzy file and directory search
193 | # - CTRL-O to open with `open` command,
194 | # - CTRL-E or Enter key to open with the $EDITOR
195 | # - CTRL-S to search inside files
196 | # - CTRL-C to copy file path to clipboard
197 | # - CTRL-D to cd to directory of file
198 | # - CTRL-N to make a new markdown file.
199 | #"
200 | function fs() {
201 |   local out file key
202 |   IFS=$'\n' out=($(fzf -i --preview="bat {}" --query="$1" --exit-0 --expect=ctrl-o,ctrl-e,ctrl-s,ctrl-m,ctrl-c,ctrl-d,ctrl-x,ctrl-n --bind '?:toggle-preview'))
203 |   key=$(head -1 <<< "$out")
204 |   file=$(head -2 <<< "$out" | tail -1)
205 |   esfile=$(printf %q "$file")
206 |   if [ -n "$file" ]; then
207 |     [ "$key" = ctrl-o ] && open "$file" ||
208 |     [ "$key" = ctrl-s ] && infile "$1" ||
209 |     [ "$key" = ctrl-c ] && echo "$file" | pbcopy || 
210 |     [ "$key" = ctrl-d ] && cd $(dirname "$file") ||
211 |     xi "$file"
212 |   fi
213 | }
214 | 
215 | # [ "$key" = ctrl-n ] && xi "$1.md" ||Add when compatible
216 | 
217 | function infile() {
218 |   rg "$1" | fzf --height 40% | sed 's/:.*$//g' | sed 's/ /\\ /g' | sed 's/&/\\&/g' | xargs -0 -I {} /bin/zsh -c 'vim {}'
219 | }
220 | 
221 | 
222 | function fuz() {
223 |   previous_file="$1"
224 |   file_to_edit=`select_file $previous_file`
225 |   if [ -n "$file_to_edit" ] ; then
226 |     macdown "$file_to_edit"
227 |   fi
228 | }
229 | 
230 | function select_file() {
231 |   given_file="$1"
232 |   fzf --preview="pygmentize -g {}" --query="$given_file" --bind '?:toggle-preview'
233 | }
234 | 
235 | function dtf() {
236 |   # rg $1 $(fzf --preview="pygmentize -g {}")
237 |   sk --ansi -c 'rg --color=always --line-number "{}"' -q $1
238 | }
239 | 
240 | ## Convert from gif or webm to mp4
241 | #;
242 | # 2mp4()
243 | # Convert from gif or webm to mp4 for all in current directory
244 | # @param type: mp4 or gif
245 | #"
246 | function 2mp4() {
247 |   type="$1"
248 |   if [[ $type = gif ]]; then
249 |     fd -e gif -x ffmpeg -i "{}" -movflags faststart -pix_fmt yuv420p -vf "scale=trunc(iw/2)*2:trunc(ih/2)*2" "{.}.mp4"
250 |   elif [[ $type = webm ]]; then
251 |     fd -e webm -x ffmpeg -fflags +genpts -i "{}" -r 25 "{.}.mp4"
252 |   else
253 |     echo "Invalid argument. Please choose gif or webm."
254 |   fi
255 | }
256 | 
257 | ## Remove an unwanted watched folder
258 | #;
259 | # gitrm()
260 | # Remove an unwanted watched folder
261 | # @param filename: file type to be removed from this folder
262 | #"
263 | function gitrm() {
264 |   git rm --cached --force -r "$1"
265 | }
266 | 
267 | ## Generate a .gitignore file for python projects
268 | #;
269 | # pygnore()
270 | # Generate a .gitignore file for python projects
271 | #"
272 | function pygnore() {
273 |   gi python,jetbrains+all,visualstudiocode > .gitignore
274 | }
275 | 
276 | ## Fuzzy search git branches
277 | #;
278 | # fbr()
279 | # Fuzzy search git branches
280 | #"
281 | function fbr() {
282 |   local branches branch
283 |   branches=$(git branch --all | rg -v HEAD) &&
284 |   branch=$(echo "$branches" |
285 |            fzf-tmux -d $(( 2 + $(wc -l <<< "$branches") )) +m) &&
286 |   git checkout $(echo "$branch" | sed "s/.* //" | sed "s#remotes/[^/]*/##")
287 | }
288 | 
289 | ## Preview git tree
290 | #;
291 | # fshow()
292 | # Preview git tree
293 | #"
294 | function fshow() {
295 |   git log --graph --color=always \
296 |       --format="%C(auto)%h%d %s %C(black)%C(bold)%cr" "$@" |
297 |   fzf --ansi --no-sort --reverse --tiebreak=index --bind=ctrl-s:toggle-sort \
298 |       --bind "ctrl-m:execute:
299 |                 (rg '[a-f0-9]\{7\}' | head -1 |
300 |                 xargs -I % sh -c 'git show --color=always % | less -R') << 'FZF-EOF'
301 |                 {}
302 | FZF-EOF"
303 | }
304 | 
305 | ## Show uncommitted files
306 | #;
307 | # fstat()
308 | # Show uncommitted files
309 | # 
310 | #"
311 | function fstat() {
312 |   code $(git status --porcelain | rg -v '^[AMD]' | sed s/^...// | fzf -m)
313 | }
314 | 
315 | # .gitignore file generator
316 | # gi() { 
317 | #   curl -L -s https://www.gitignore.io/api/$@ ;
318 | # }
319 | 
320 | #!/bin/sh
321 | 
322 | # Create useful gitignore files
323 | # Usage: gi [param]
324 | # param is a comma separated list of ignore profiles.
325 | # If param is ommited choose interactively.
326 | 
327 | ## # .gitignore file generator
328 | #;
329 | # gi()
330 | # .gitignore file generator
331 | # @param list: list of types to generator gitignore of
332 | #"
333 | function gi() {
334 |   curl -L -s https://www.gitignore.io/api/"$@"
335 | }
336 | 
337 | ## Initialize a git directory
338 | #;
339 | # setgit()
340 | # Initialize a git directory
341 | # @param giturl: url of git repo push to
342 | #"
343 | function setgit() {
344 |   git init; git add .; git commit -m "first commit"; git remote add origin "$1"; git push -u origin master
345 | }
346 | 
347 | #;
348 | # gup()
349 | # set up stream of passed in branch to origin
350 | # @param branch: name of branch
351 | #"
352 | function gup() {
353 |   git push --set-upstream "$1"
354 | }
355 | 
356 | ## Open man page in Preview.app
357 | #;
358 | # psman()
359 | # Open man page in Preview.app
360 | # @param cli: command line function to call man on
361 | #"
362 | function psman() {
363 | 	man -t "${1}" | open -f -a /Applications/Preview.app/
364 | }
365 | 
366 | function ppundo() {
367 |   prev="$(history | tail -10 | rg "npm install" | fzf | awk '{print $NF}')"
368 |   echo $prev
369 |   "$1" uninstall "$prev"
370 | }
371 | 
372 | # treeg() {
373 | #   tree -I "venv|node_modules|.git|.vscode|.idea"
374 | # }
375 | # EXTRANEOUS OPTIMIZATIONS
376 | defaults write -g KeyRepeat -int 1
377 | 
378 | test -e "${HOME}/.iterm2_shell_integration.zsh" && source "${HOME}/.iterm2_shell_integration.zsh"
379 | # [[ -s "$HOME/.local/share/marker/marker.sh" ]] && source "$HOME/.local/share/marker/marker.sh"
380 | [ -f ~/.fzf.zsh ] && source ~/.fzf.zsh
381 | export FZF_DEFAULT_COMMAND='rg --files --follow -g "!{.git,node_modules,venv}/*" 2> /dev/null'
382 | export FZF_CTRL_T_COMMAND="$FZF_DEFAULT_COMMAND"
383 | # fpath=(~/.zsh_fns $fpath)
384 | # export FZF_DEFAULT_COMMAND='fd --type f'
385 | 
386 | 
387 | # ZSH STUFF
388 | # Set name of the theme to load. Optionally, if you set this to "random"
389 | # it'll load a random theme each time that oh-my-zsh is loaded.
390 | # See https://github.com/robbyrussell/oh-my-zsh/wiki/Themes
391 | # ZSH_THEME="refined"
392 | # robbyrussell as alternative theme
393 | # Uncomment the following line to use case-sensitive completion.
394 | # CASE_SENSITIVE="true"
395 | 
396 | # Uncomment the following line to use hyphen-insensitive completion. Case
397 | # sensitive completion must be off. _ and - will be interchangeable.
398 | # HYPHEN_INSENSITIVE="true"
399 | 
400 | # Uncomment the following line to disable bi-weekly auto-update checks.
401 | # DISABLE_AUTO_UPDATE="true"
402 | 
403 | # Uncomment the following line to change how often to auto-update (in days).
404 | # export UPDATE_ZSH_DAYS=13
405 | 
406 | # Uncomment the following line to disable colors in ls.
407 | # DISABLE_LS_COLORS="true"
408 | 
409 | # Uncomment the following line to disable auto-setting terminal title.
410 | # DISABLE_AUTO_TITLE="true"
411 | 
412 | # Uncomment the following line to enable command auto-correction.
413 | # ENABLE_CORRECTION="true"
414 | 
415 | # Uncomment the following line to display red dots whilst waiting for completion.
416 | COMPLETION_WAITING_DOTS="true"
417 | 
418 | # Uncomment the following line if you want to disable marking untracked files
419 | # under VCS as dirty. This makes repository status check for large repositories
420 | # much, much faster.
421 | # DISABLE_UNTRACKED_FILES_DIRTY="true"
422 | 
423 | # Uncomment the following line if you want to change the command execution time
424 | # stamp shown in the history command output.
425 | # The optional three formats: "mm/dd/yyyy"|"dd.mm.yyyy"|"yyyy-mm-dd"
426 | # HIST_STAMPS="mm/dd/yyyy"
427 | 
428 | # Would you like to use another custom folder than $ZSH/custom?
429 | # ZSH_CUSTOM=/path/to/new-custom-folder
430 | 
431 | # Which plugins would you like to load? (plugins can be found in ~/.oh-my-zsh/plugins/*)
432 | # Custom plugins may be added to ~/.oh-my-zsh/custom/plugins/
433 | # Example format: plugins=(rails git textmate ruby lighthouse)
434 | # Add wisely, as too many plugins slow down shell startup.
435 | plugins=(
436 |     git 
437 |     npm  
438 |     osx 
439 |     z 
440 |     zsh-syntax-highlighting 
441 |     zsh-autosuggestions
442 |     )
443 | 
444 | source $ZSH/oh-my-zsh.sh
445 | 
446 | # User configuration
447 | 
448 | # export MANPATH="/usr/local/man:$MANPATH"
449 | 
450 | # You may need to manually set your language environment
451 | # export LANG=en_US.UTF-8
452 | 
453 | # Compilation flags
454 | # export ARCHFLAGS="-arch x86_64"
455 | 
456 | # ssh
457 | export SSH_KEY_PATH="~/.ssh/rsa_id"
458 | 
459 | # Set personal aliases, overriding those provided by oh-my-zsh libs,
460 | # plugins, and themes. Aliases can be placed here, though oh-my-zsh
461 | # users are encouraged to define aliases within the ZSH_CUSTOM folder.
462 | # For a full list of active aliases, run `alias`.
463 | #
464 | # Example aliases
465 | # alias ohmyzsh="mate ~/.oh-my-zsh"
466 | autoload -U promptinit; promptinit
467 | prompt pure
468 | # allow locally installed npm binaries to be executed;
469 | # added by `npm i -g add-local-binaries-to-path`
470 | 
471 | # # tabtab source for serverless package
472 | # # uninstall by removing these lines or running `tabtab uninstall serverless`
473 | # [[ -f /usr/local/lib/node_modules/serverless/node_modules/tabtab/.completions/serverless.zsh ]] && . /usr/local/lib/node_modules/serverless/node_modules/tabtab/.completions/serverless.zsh
474 | # # tabtab source for sls package
475 | # # uninstall by removing these lines or running `tabtab uninstall sls`
476 | # [[ -f /usr/local/lib/node_modules/serverless/node_modules/tabtab/.completions/sls.zsh ]] && . /usr/local/lib/node_modules/serverless/node_modules/tabtab/.completions/sls.zsh
477 | 


--------------------------------------------------------------------------------
/example/zshrc.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dustinknopoff/bashdoc/0ebc6d2ef615818c30b14d1ea0644664a9e872bb/example/zshrc.png


--------------------------------------------------------------------------------
/src/docs.rs:
--------------------------------------------------------------------------------
  1 | use self::delims::*;
  2 | use self::doc::*;
  3 | use self::docfile::*;
  4 | use self::kv::*;
  5 | use self::outputs::*;
  6 | use clap::ArgMatches;
  7 | use dirs::home_dir;
  8 | use glob::glob;
  9 | use handlebars::{to_json, Handlebars};
 10 | use nom::types::CompleteStr;
 11 | use nom::*;
 12 | use nom_locate::{position, LocatedSpan};
 13 | use serde::{Deserialize, Serialize};
 14 | use std::{
 15 |     borrow::Cow,
 16 |     collections::HashMap,
 17 |     env,
 18 |     error::Error,
 19 |     fs,
 20 |     fs::File,
 21 |     path::{Path, PathBuf},
 22 |     process::exit,
 23 | };
 24 | 
 25 | /// Given a string, convert it into a valid Path that is canonical and absolute.
 26 | pub fn make_path(raw: Cow<str>) -> PathBuf {
 27 |     let mut path = PathBuf::from(raw.into_owned());
 28 |     if path.starts_with("~") {
 29 |         path = home_dir().expect("Could not find home directory.").join(
 30 |             path.strip_prefix("~")
 31 |                 .expect("Could not remove ~ from file path."),
 32 |         );
 33 |     }
 34 |     path.canonicalize().unwrap()
 35 | }
 36 | 
 37 | /// "Main" of bashdoc
 38 | pub mod runners {
 39 |     use super::*;
 40 |     use notify::{DebouncedEvent, RecommendedWatcher, RecursiveMode, Watcher};
 41 |     use std::{sync::mpsc::channel, time::Duration};
 42 | 
 43 |     /// Given the arguments received via CLI from clap, setup and run with requested delimiters, file or directory, etc.
 44 |     pub fn generate<'a>(matches: &'a ArgMatches<'a>) {
 45 |         let delims = match matches.subcommand() {
 46 |             ("override", Some(sub_m)) => Delimiters::override_delims(sub_m),
 47 |             _ => Delimiters::get_delims(),
 48 |         };
 49 |         let all_em = start(
 50 |             Cow::Borrowed(matches.value_of("INPUT").expect("directory glob not found")),
 51 |             delims,
 52 |         )
 53 |         .unwrap();
 54 |         if matches.is_present("json") {
 55 |             write_json(&all_em, matches.value_of("json").unwrap());
 56 |         } else if matches.is_present("location") {
 57 |             to_html(
 58 |                 &all_em,
 59 |                 Option::Some(matches.value_of("location").unwrap()),
 60 |                 matches.value_of("template"),
 61 |             );
 62 |         } else {
 63 |             for doc in &all_em {
 64 |                 if matches.is_present("color") {
 65 |                     printer(doc, true);
 66 |                 } else {
 67 |                     printer(doc, false);
 68 |                 }
 69 |             }
 70 |         };
 71 |     }
 72 | 
 73 |     /// Given a request to watch files, Call `generate` on file write.
 74 |     pub fn watcher<'a>(matches: &'a ArgMatches<'a>) {
 75 |         generate(matches);
 76 |         let (tx, rx) = channel();
 77 |         let mut watcher: RecommendedWatcher = match Watcher::new(tx, Duration::from_secs(2)) {
 78 |             Ok(d) => d,
 79 |             Err(_) => {
 80 |                 println!("Provided path is invalid");
 81 |                 exit(1);
 82 |             }
 83 |         };
 84 |         let path: String = make_path(Cow::Borrowed(matches.value_of("INPUT").unwrap()))
 85 |             .to_str()
 86 |             .unwrap()
 87 |             .to_owned();
 88 |         watcher.watch(&path, RecursiveMode::Recursive).unwrap();
 89 |         println!("Watching for changes in {}...", path);
 90 |         loop {
 91 |             match rx.recv() {
 92 |                 Ok(event) => {
 93 |                     generate(matches);
 94 |                     if let DebouncedEvent::Write(e) = event {
 95 |                         println!(
 96 |                             "Bashdoc updated to match changes to {}.",
 97 |                             e.as_path().file_name().unwrap().to_str().unwrap()
 98 |                         );
 99 |                     }
100 |                 }
101 |                 Err(e) => println!("watch error: {:?}", e),
102 |             }
103 |         }
104 |     }
105 | }
106 | 
107 | /// Functions and declarations for general Key,Value Pair
108 | mod kv {
109 |     use super::*;
110 |     /// Represents a simple Key, Value pair
111 |     #[derive(Debug, Default, Serialize, Deserialize, Clone)]
112 |     pub struct KV {
113 |         pub key: String,
114 |         pub value: String,
115 |     }
116 | 
117 |     impl PartialEq for KV {
118 |         fn eq(&self, other: &KV) -> bool {
119 |             self.key == other.key && self.value == other.value
120 |         }
121 |     }
122 | 
123 |     impl KV {
124 |         #[allow(dead_code)]
125 |         pub fn new(key: String, value: String) -> Self {
126 |             KV { key, value }
127 |         }
128 |     }
129 | 
130 |     /// Nom function to convert a given string into a `KV`
131 |     ///
132 |     /// # Example
133 |     ///
134 |     /// ```
135 |     /// let example = "# @param filename: don't test me";
136 |     /// as_kv(example) // returns [KV {key: "filename", value: "don't test me"}]
137 |     /// ```
138 |     pub fn as_kv(input: &str) -> Result<KV, nom::ErrorKind> {
139 |         let parts: Vec<_> = if input.contains(':') {
140 |             input.split(": ").collect()
141 |         } else {
142 |             input.split_whitespace().collect()
143 |         };
144 |         let result = KV {
145 |             key: parts[0].trim().to_string(),
146 |             value: parts[1..].join(" ").to_string(),
147 |         };
148 |         Ok(result)
149 |     }
150 | }
151 | 
152 | /// Functions and declarations for Docs and parsing from strings
153 | mod doc {
154 |     use super::*;
155 |     /// Represents a docstring
156 |     #[derive(Debug, Serialize, Deserialize, Clone, Default)]
157 |     pub struct Doc {
158 |         pub short_description: String,
159 |         pub long_description: String,
160 |         pub descriptors: Vec<KV>,
161 |         pub params: Vec<KV>,
162 |         pub returns: Vec<KV>,
163 |         pub position: u32,
164 |     }
165 | 
166 |     impl PartialEq for Doc {
167 |         fn eq(&self, other: &Doc) -> bool {
168 |             self.short_description == other.short_description
169 |                 && self.long_description == other.long_description
170 |                 && self.descriptors == other.descriptors
171 |                 && self.params == other.params
172 |                 && self.returns == other.returns
173 |         }
174 |     }
175 | 
176 |     /// Nom function to convert a given string in to a `Doc`
177 |     #[allow(clippy::cognitive_complexity)]
178 |     pub fn parse_doc<'a>(input: &'a str, delims: Delimiters) -> IResult<&'a str, Doc> {
179 |         do_parse!(
180 |             input,
181 |             short:
182 |                 preceded!(
183 |                     take_until_and_consume!(delims.comm),
184 |                     take_until_and_consume!("\n")
185 |                 )
186 |                 >> long: opt!(preceded!(
187 |                     take_until_and_consume!(delims.comm),
188 |                     take_until_and_consume!("\n")
189 |                 ))
190 |                 >> par: opt!(many0!(complete!(map_res!(
191 |                     preceded!(
192 |                         take_until_and_consume!(delims.params),
193 |                         take_until_and_consume!("\n")
194 |                     ),
195 |                     as_kv
196 |                 ))))
197 |                 >> desc: opt!(many0!(complete!(map_res!(
198 |                     preceded!(
199 |                         take_until_and_consume!(delims.opt),
200 |                         take_until_and_consume!("\n")
201 |                     ),
202 |                     as_kv
203 |                 ))))
204 |                 >> ret: opt!(many0!(complete!(map_res!(
205 |                     preceded!(
206 |                         take_until_and_consume!(delims.ret),
207 |                         take_until_and_consume!("\n")
208 |                     ),
209 |                     as_kv
210 |                 ))))
211 |                 >> (Doc {
212 |                     short_description: short.to_string(),
213 |                     long_description: long.unwrap_or("").to_string(),
214 |                     descriptors: desc.unwrap_or_default(),
215 |                     params: par.unwrap_or_default(),
216 |                     returns: ret.unwrap_or_default(),
217 |                     position: 0
218 |                 })
219 |         )
220 |     }
221 | 
222 |     impl Doc {
223 |         /// Build a `Doc` from an array of strings
224 |         /// Parse `Doc` fields.
225 |         pub fn make_doc(vector: &Extracted, delims: Delimiters) -> Result<Doc, nom::ErrorKind> {
226 |             // println!("{:#?}", vector);
227 |             let parsed = parse_doc(&vector.content, delims);
228 |             let mut result = match parsed {
229 |                 Ok(e) => e.1,
230 |                 Err(_) => Default::default(),
231 |             };
232 |             result.position = vector.position.line + 1;
233 |             Ok(result)
234 |         }
235 |     }
236 | }
237 | 
238 | /// Functions and declarations for DocFile's and parsing
239 | mod docfile {
240 |     use super::*;
241 |     use rayon::prelude::*;
242 |     use std::io::prelude::*;
243 |     /// Represents all documentation in a file
244 |     #[derive(Debug, Default, Serialize, Deserialize)]
245 |     pub struct DocFile {
246 |         pub thedocs: Vec<Doc>,
247 |         pub filename: String,
248 |     }
249 | 
250 |     impl DocFile {
251 |         /// Append the given `Doc` to this `AllDoc`
252 |         #[allow(dead_code)]
253 |         pub fn add(&mut self, doc: Doc) {
254 |             self.thedocs.push(doc)
255 |         }
256 |     }
257 | 
258 |     pub type Span<'a> = LocatedSpan<CompleteStr<'a>>;
259 |     /// Represents the string extracted from a file, including it's location in the file found.
260 |     pub struct Extracted<'a> {
261 |         pub position: Span<'a>,
262 |         pub content: String,
263 |     }
264 | 
265 |     /// Nom function to extract all docstring from a file.
266 |     pub fn parse_strings_from_file(
267 |         input: Span<'static>,
268 |         delims: Delimiters,
269 |     ) -> IResult<Span<'static>, Vec<Extracted<'static>>> {
270 |         many0!(
271 |             input,
272 |             do_parse!(
273 |                 content:
274 |                     complete!(preceded!(
275 |                         take_until_and_consume!(delims.start),
276 |                         take_until_and_consume!(delims.end)
277 |                     ))
278 |                     >> pos: position!()
279 |                     >> (Extracted {
280 |                         position: pos,
281 |                         content: content.to_string()
282 |                     })
283 |             )
284 |         )
285 |     }
286 | 
287 |     /// Gets all `START_DELIM->END_DELIM` comments in the zshrc
288 |     ///
289 |     /// This goes through every line finding the start of the docstring
290 |     /// and adds every line to a `Vec` until the end delimiter.
291 |     ///
292 |     /// A final `Vec` of the collected comment strings is returned.
293 |     pub fn get_strings_from_file<'a>(
294 |         p: &Path,
295 |         delims: Delimiters,
296 |     ) -> Result<Vec<Extracted<'a>>, Box<dyn Error>> {
297 |         let mut file = File::open(p)?;
298 |         let mut contents = String::new();
299 |         file.read_to_string(&mut contents)?;
300 |         let used = Box::leak(contents.into_boxed_str());
301 |         let x = parse_strings_from_file(Span::new(CompleteStr(used)), delims)?;
302 |         Ok(x.1)
303 |     }
304 | 
305 |     /// Given a `Vec<str>` make a `DocFile`
306 |     pub fn generate_doc_file(
307 |         docs: &[Extracted<'static>],
308 |         fname: &Path,
309 |         delims: Delimiters,
310 |     ) -> DocFile {
311 |         let mut all_docs: DocFile = DocFile {
312 |             filename: String::from(fname.file_stem().unwrap().to_str().unwrap()),
313 |             ..Default::default()
314 |         };
315 |         let collected: Vec<Doc> = docs
316 |             .par_iter()
317 |             .filter(|x| !x.content.is_empty())
318 |             .map(|x| Doc::make_doc(x, delims).unwrap())
319 |             .collect();
320 |         all_docs.thedocs = collected;
321 |         all_docs
322 |     }
323 | 
324 |     fn extract_all_paths(p: Cow<str>) -> Result<Vec<PathBuf>, String> {
325 |         let files: Vec<_> = if p.contains('*') {
326 |             glob(make_path(p).to_str().unwrap())
327 |                 .unwrap()
328 |                 .filter_map(|x| x.ok())
329 |                 .collect()
330 |         } else {
331 |             vec![make_path(p)]
332 |         };
333 |         Ok(files)
334 |     }
335 | 
336 |     /// Given a file path and delimiters, generate a DocFile for all files requested.
337 |     pub fn start(p: Cow<str>, delims: Delimiters) -> Result<Vec<DocFile>, String> {
338 |         let x: Vec<PathBuf> = extract_all_paths(p).map_err(|e| e.to_string())?;
339 |         Ok(x.par_iter()
340 |             .map(|entry| {
341 |                 let docs = match get_strings_from_file(entry, delims) {
342 |                     Ok(o) => o,
343 |                     Err(e) => {
344 |                         println!("{}", e);
345 |                         exit(1);
346 |                     }
347 |                 };
348 |                 generate_doc_file(&docs, entry, delims)
349 |             })
350 |             .collect())
351 |     }
352 | }
353 | 
354 | /// Functions for presenting bashdocs to STDOUT, as JSON, or HTML
355 | mod outputs {
356 |     use super::*;
357 |     use colored::*;
358 |     use std::io::prelude::*;
359 |     /// Pretty print an `DocFile`
360 |     ///
361 |     /// Given an `AllDoc`:
362 |     /// ```
363 |     ///[
364 |     ///    Doc {
365 |     ///        short_description: "runner()",
366 |     ///        long_description: "This is the beginning",
367 |     ///        descriptors: {
368 |     ///            "CTRL-O": "pushs the boundaries"
369 |     ///        },
370 |     ///        params: {},
371 |     ///        returns: {}
372 |     ///    },
373 |     ///    Doc {
374 |     ///        short_description: "runner()",
375 |     ///        long_description: "This is the beginning",
376 |     ///        descriptors: {},
377 |     ///        params: {
378 |     ///            "location": "where to put it",
379 |     ///            "filename": "don\'t test me"
380 |     ///        },
381 |     ///        returns: {
382 |     ///            "nothing": ""
383 |     ///        }
384 |     ///    }
385 |     ///]
386 |     /// ```
387 |     /// The following will be printed to the `STDOUT` with color
388 |     /// ```
389 |     /// Help
390 |     /// runner: This is the beginning
391 |     ///     CTRL-O pushs the boundaries
392 |     /// runner - location, filename: This is the beginning
393 |     /// ```
394 |     pub fn printer(thedocs: &DocFile, use_color: bool) {
395 |         if use_color {
396 |             println!(
397 |                 "{}: {}",
398 |                 "Help".green().underline(),
399 |                 thedocs.filename.green().underline()
400 |             );
401 |             for doc in &thedocs.thedocs {
402 |                 let params: Vec<&str> = doc.params.iter().map(|x| x.key.as_str()).collect();
403 |                 let as_string = params.join(", ");
404 |                 print!("{}", doc.short_description.replace("()", "").blue().bold());
405 |                 if doc.params.is_empty() {
406 |                     println!(": {}", doc.long_description);
407 |                 } else {
408 |                     println!(" - {}: {}", as_string.cyan(), doc.long_description);
409 |                 }
410 |                 if !doc.descriptors.is_empty() {
411 |                     doc.descriptors
412 |                         .iter()
413 |                         .for_each(|x| println!("\t{} {}", &x.key.yellow().bold(), x.value));
414 |                 }
415 |             }
416 |         } else {
417 |             println!("Help: {}", thedocs.filename);
418 |             for doc in &thedocs.thedocs {
419 |                 let params: Vec<&str> = doc.params.iter().map(|x| x.key.as_str()).collect();
420 |                 let as_string = params.join(", ");
421 |                 print!("{}", doc.short_description.replace("()", ""));
422 |                 if doc.params.is_empty() {
423 |                     println!(": {}", doc.long_description);
424 |                 } else {
425 |                     println!(" - {}: {}", as_string, doc.long_description);
426 |                 }
427 |                 if !doc.descriptors.is_empty() {
428 |                     doc.descriptors
429 |                         .iter()
430 |                         .for_each(|x| println!("\t{} {}", &x.key, x.value));
431 |                 }
432 |             }
433 |         }
434 |     }
435 | 
436 |     /// Given a list of `DocFile` and a file path, write the JSON representation to a file.
437 |     pub fn write_json(docstrings: &[DocFile], file_name: &str) {
438 |         let mut map = HashMap::new();
439 |         map.insert("docs", docstrings);
440 |         let json = serde_json::to_string_pretty(&map).expect("Could not convert to JSON");
441 |         let path_as_str = if cfg!(windows) {
442 |             String::from(file_name)
443 |         } else {
444 |             file_name.replace("~", home_dir().unwrap().to_str().unwrap())
445 |         };
446 |         let path = Path::new(&path_as_str);
447 |         let mut file = File::create(Path::new(&path)).expect("Invalid file path.");
448 |         file.write_all(json.as_bytes())
449 |             .expect("Could not write to file.");
450 |     }
451 | 
452 |     pub fn to_html(docstrings: &[DocFile], dir: Option<&str>, template_loc: Option<&str>) {
453 |         for dfile in docstrings {
454 |             let json = to_json(dfile);
455 |             let handlebars = Handlebars::new();
456 |             let mut template = match template_loc {
457 |                 Some(m) => match File::open(m) {
458 |                     Ok(o) => o,
459 |                     Err(_) => {
460 |                         std::dbg!("Provided path is invalid");
461 |                         exit(1);
462 |                     }
463 |                 },
464 |                 None => File::open("./static/template.hbs").unwrap(),
465 |             };
466 |             // let mut template = File::open("./static/template.hbs").unwrap();
467 |             let mut output = match dir {
468 |                 Some(d) if Path::new(d).is_dir() => {
469 |                     File::create(format!("{}/{}.html", d, dfile.filename).as_str())
470 |                         .expect("File could not be created")
471 |                 }
472 |                 None | Some(_) => {
473 |                     std::dbg!("Provided path is invalid");
474 |                     exit(1);
475 |                 }
476 |             };
477 |             // let mut output = if dir.len() == 1 {
478 |             //     File::create(format!("{}.html", dfile.filename).as_str())
479 |             //         .expect("File cannot be created")
480 |             // } else {
481 |             //     File::create(format!("{}/{}.html", dir, dfile.filename).as_str())
482 |             //         .expect("File cannot be created")
483 |             // };
484 |             handlebars
485 |                 .render_template_source_to_write(&mut template, &json, &mut output)
486 |                 .expect("Could not generate documentation");
487 |         }
488 |     }
489 | }
490 | 
491 | /// Functions and declarations for generating/overriding delimiters
492 | mod delims {
493 |     use super::*;
494 |     use std::io::prelude::*;
495 |     /// Represents the necessary delimiters for a `bashdoc`
496 |     #[derive(Debug, Serialize, Deserialize, Copy, Clone)]
497 |     pub struct Delimiters<'a> {
498 |         pub start: &'a str,
499 |         pub end: &'a str,
500 |         pub params: &'a str,
501 |         pub ret: &'a str,
502 |         pub opt: &'a str,
503 |         pub comm: &'a str,
504 |     }
505 | 
506 |     impl<'a> Default for Delimiters<'a> {
507 |         fn default() -> Delimiters<'a> {
508 |             Delimiters {
509 |                 start: "#;",
510 |                 end: "#\"",
511 |                 params: "@param",
512 |                 ret: "@return",
513 |                 opt: "# -",
514 |                 comm: "# ",
515 |             }
516 |         }
517 |     }
518 |     impl<'a> Delimiters<'a> {
519 |         /// Override default delimiters with passed in values
520 |         pub fn override_delims(overrides: &'a ArgMatches<'a>) -> Self {
521 |             let mut result: Delimiters = Delimiters::default();
522 |             for key in overrides.args.keys() {
523 |                 match key.as_ref() {
524 |                     "start" => result.start = overrides.value_of(key).unwrap(),
525 |                     "end" => result.end = overrides.value_of(key).unwrap(),
526 |                     "descriptor" => result.opt = overrides.value_of(key).unwrap(),
527 |                     "params" => result.params = overrides.value_of(key).unwrap(),
528 |                     "returns" => result.ret = overrides.value_of(key).unwrap(),
529 |                     "comment" => result.comm = overrides.value_of(key).unwrap(),
530 |                     _ => {}
531 |                 }
532 |             }
533 |             result
534 |         }
535 | 
536 |         /// Read/Write contents of `$BASHDOC_CONFIG_PATH` for use as Delimiters.
537 |         pub fn get_delims() -> Self {
538 |             let mut contents = String::new();
539 |             if env::current_dir().unwrap().join(".bashdocrc").is_file() {
540 |                 let mut config =
541 |                     File::open(Path::new(&env::current_dir().unwrap().join(".bashdocrc")))
542 |                         .expect("Invalid path");
543 |                 config
544 |                     .read_to_string(&mut contents)
545 |                     .expect("could not read from file.");
546 |                 let mut to_convert = String::new();
547 |                 to_convert.push_str(&contents);
548 |                 let as_static: &'static str = Box::leak(to_convert.into_boxed_str());
549 |                 let sorted: Delimiters = toml::from_str(as_static).unwrap();
550 |                 sorted
551 |             } else {
552 |                 match env::var_os("BASHDOC_CONFIG_PATH") {
553 |                     Some(val) => {
554 |                         let mut config = File::open(Path::new(&val)).expect("Invalid path");
555 |                         config
556 |                             .read_to_string(&mut contents)
557 |                             .expect("could not read from file.");
558 |                         let mut to_convert = String::new();
559 |                         to_convert.push_str(&contents);
560 |                         let as_static: &'static str = Box::leak(to_convert.into_boxed_str());
561 |                         let sorted: Delimiters = toml::from_str(as_static).unwrap();
562 |                         sorted
563 |                     }
564 |                     None => {
565 |                         let delimiters = Delimiters::default();
566 |                         let content = toml::to_string_pretty(&delimiters)
567 |                             .expect("Could not be converted to TOML");
568 |                         let mut path = home_dir().unwrap();
569 |                         path.push(".bashdocrc");
570 |                         fs::write(path.to_str().unwrap(), content).unwrap();
571 |                         env::set_var("BASHDOC_CONFIG_PATH", path);
572 |                         delimiters
573 |                     }
574 |                 }
575 |             }
576 |         }
577 |     }
578 | }
579 | 
580 | #[cfg(test)]
581 | mod tests {
582 |     use super::*;
583 |     mod kv_tests {
584 |         use super::*;
585 |         #[test]
586 |         fn new_kv() {
587 |             let kv = KV::new(String::from("a"), String::from("b"));
588 |             assert_eq!(String::from("a"), kv.key);
589 |             assert_eq!(String::from("b"), kv.value);
590 |         }
591 | 
592 |         #[test]
593 |         fn cmp_kv() {
594 |             let kv1 = KV::new(String::from("a"), String::from("b"));
595 |             let kv2 = KV::new(String::from("a"), String::from("b"));
596 |             let kv = KV::new(String::from("b"), String::from("a"));
597 |             assert_eq!(kv1, kv2);
598 |             assert_ne!(kv1, kv);
599 |         }
600 | 
601 |         #[test]
602 |         fn is_as_kv() {
603 |             let conv = as_kv("type: mp4 or gif");
604 |             assert_eq!(
605 |                 KV {
606 |                     key: String::from("type"),
607 |                     value: String::from("mp4 or gif")
608 |                 },
609 |                 conv.unwrap()
610 |             );
611 |         }
612 | 
613 |         #[test]
614 |         fn is_as_kv_white() {
615 |             let conv = as_kv("CTRL-O to open with `open` command,");
616 |             assert_eq!(
617 |                 KV {
618 |                     key: String::from("CTRL-O"),
619 |                     value: String::from("to open with `open` command,")
620 |                 },
621 |                 conv.unwrap()
622 |             );
623 |         }
624 |     }
625 | 
626 |     mod docfile_tests {
627 |         use super::*;
628 |         #[test]
629 |         fn test_add() {
630 |             let mut dfile = DocFile {
631 |                 thedocs: Vec::new(),
632 |                 filename: String::from("zshrc"),
633 |             };
634 |             dfile.add(Doc {
635 |                 short_description: String::from("lala"),
636 |                 long_description: String::from("rawr"),
637 |                 descriptors: Vec::new(),
638 |                 params: Vec::new(),
639 |                 returns: Vec::new(),
640 |                 position: 0,
641 |             });
642 |             assert_eq!(
643 |                 dfile.thedocs,
644 |                 [Doc {
645 |                     short_description: String::from("lala"),
646 |                     long_description: String::from("rawr"),
647 |                     descriptors: Vec::new(),
648 |                     params: Vec::new(),
649 |                     returns: Vec::new(),
650 |                     position: 0,
651 |                 }]
652 |             );
653 |         }
654 |     }
655 | 
656 |     #[test]
657 |     fn param_and_input() {
658 |         let sample = "#\"
659 |         # mp()
660 |         # Convert from markdown to docx
661 |         # @param input: markdown file to convert
662 |         # - MSG: the message to pass
663 |         #;
664 |         ";
665 |         let delims = Delimiters::get_delims();
666 |         let x = Extracted {
667 |             content: sample.into(),
668 |             position: Span::new(CompleteStr(sample)),
669 |         };
670 | 
671 |         let val = generate_doc_file(&[x], Path::new("/example.txt"), delims);
672 |         println!("{:#?}", val);
673 |     }
674 | }
675 | 


--------------------------------------------------------------------------------
/src/main.rs:
--------------------------------------------------------------------------------
  1 | //!# BashDoc
  2 | //!
  3 | //!A tool for generating documentation/help menu for ~~user defined bash functions~~ any folder or file with 6 generic delimiters defined.
  4 | //!
  5 | //!## Syntax
  6 | //!
  7 | //!### Example
  8 | //!
  9 | //! Using syntax similar to below
 10 | //!
 11 | //!```bash
 12 | //!#;
 13 | //!# cd()
 14 | //!# moves to given directory
 15 | //!# @param directory: folder to move to
 16 | //!# @return void
 17 | //!#"
 18 | //!cd() {
 19 | //!    cd $1
 20 | //!}
 21 | //!```
 22 | //!
 23 | //!on my `zshrc` Outputs
 24 | //!
 25 | //!![](https://github.com/dustinknopoff/bashdoc/raw/master/example/zshrc.png)
 26 | //!
 27 | //!with lots of color!
 28 | //!
 29 | //!### Global Delimiters
 30 | //!
 31 | //! The default delimiters to use are as follows:
 32 | //!
 33 | //!`START_DELIM = #;`
 34 | //!
 35 | //!`END_DELIM = #"`
 36 | //!
 37 | //!`PAR_DELIM = @param`
 38 | //!
 39 | //!`RET_DELIM = @return`
 40 | //!
 41 | //!`OPT_DELIM = # -`
 42 | //!
 43 | //!`COMM_DELIM = #`
 44 | //!
 45 | //!These can be modifed in your `.bashdocrc`.
 46 | //!
 47 | //!## Install
 48 | //!
 49 | //! ```bash
 50 | //! cargo install bashdoc
 51 | //! ```
 52 | //!
 53 | //! or from source
 54 | //!
 55 | //!**NOTE: Must use Rust 2018 Edition**
 56 | //!
 57 | //!_update with `rustup update stable`_
 58 | //!
 59 | //!```bash
 60 | //!git clone https://github.com/dustinknopoff/bashdoc
 61 | //!cd bashdoc
 62 | //!cargo install --path . --force
 63 | //!```
 64 | //!
 65 | //!## Usage
 66 | //!
 67 | //!```bash
 68 | //!bashdoc 0.4.10
 69 | //!Creates a "javadoc" like structure for bash. See github repo github.com/dustinknopoff/bashdoc for information on formatting.
 70 | //!
 71 | //!USAGE:
 72 | //!bashdoc [FLAGS] [OPTIONS] <INPUT> [SUBCOMMAND]
 73 | //!
 74 | //!FLAGS:
 75 | //!-c, --color      toggles color
 76 | //!-h, --help       Prints help information
 77 | //!-V, --version    Prints version information
 78 | //!-w, --watch      continuously update on change
 79 | //!
 80 | //!OPTIONS:
 81 | //!-j, --json <FILE>            print result as JSON
 82 | //!-l, --location <location>    location to save HTML
 83 | //!-t, --template <template>    .hbs template to use for generation of documentation
 84 | //!
 85 | //!ARGS:
 86 | //!<INPUT>    Sets the input file or glob pattern to use
 87 | //!
 88 | //!SUBCOMMANDS:
 89 | //!help        Prints this message or the help of the given subcommand(s)
 90 | //!override    override the delimiters
 91 | //!```
 92 | //!
 93 | //! See the [examples](https://github.com/dustinknopoff/bashdoc/tree/master/example) folder for more.
 94 | //!
 95 | //! See the [changelog](https://github.com/dustinknopoff/bashdoc/blob/master/CHANGELOG.md) for updates
 96 | //!
 97 | //! # Changelog
 98 | //!
 99 | //!- v0.4.0 - Added to crates.io
100 | //!- v0.4.1/v0.4.2 - Better descriptions for crates.io
101 | //!- v.0.4.5 - Fix error where bashdoc would not function for users without a `~/.bashdocrc`
102 | //!- v.0.4.6 - Improved Error handling, `--html` argument removed replaced with `--location`, `--template` argument added for supplying custom `.hbs`
103 | //!- v0.4.7 - Fix required location for all inputs and not exclusive to `--location`
104 | //!- v0.4.8 - Clearer README, link to docs.rs documentation
105 | //!- v0.4.9 - Improved error path handling
106 | //!- v0.4.10 - Support for windows file paths again
107 | //! - v0.4.11 - support for overriding global `.bashdocrc` within a directory.
108 | //! - v0.4.12 - descriptors can be split on ':' or whitespace
109 | //! - v0.5.0 - refactor for improved error handling/rust-ic code
110 | mod docs;
111 | use crate::docs::runners::*;
112 | use clap::{load_yaml, App};
113 | 
114 | fn main() {
115 |     let yaml = load_yaml!("../cli.yml");
116 |     let matches = App::from_yaml(yaml).get_matches();
117 |     if matches.is_present("watch") {
118 |         watcher(&matches);
119 |     } else {
120 |         generate(&matches);
121 |     }
122 | }
123 | 


--------------------------------------------------------------------------------
/static/template.hbs:
--------------------------------------------------------------------------------
  1 | <html>
  2 | 
  3 | <head>
  4 |     <title>{{filename}}</title>
  5 |     <style>
  6 |         .container {
  7 |   margin-top: 20vh;
  8 |   margin-bottom: 5vh;
  9 | }
 10 | 
 11 | h1 > a {
 12 |     color: black;
 13 | }
 14 | 
 15 | header {
 16 |   position: fixed;
 17 |   top: 0;
 18 |   height: 20vh;
 19 |   width: 100%;
 20 |   padding-left: 20px;
 21 | }
 22 | 
 23 | .sidebar {
 24 |   width: 33vw;
 25 |   position: fixed;
 26 | }
 27 | 
 28 | .sidebar,
 29 | ul {
 30 |   display: flex;
 31 |   flex-direction: column;
 32 |   height: 80vh;
 33 |   justify-content: space-around;
 34 | }
 35 | 
 36 | html,body {
 37 |     font-family: "SF Pro Display, sans-serif";
 38 | }
 39 | 
 40 | .content {
 41 |   margin-left: 20vw;
 42 |   width: 66vw;
 43 |   margin-bottom: 5vh;
 44 | }
 45 | 
 46 | ul {
 47 |   list-style: none;
 48 |   margin: 0;
 49 |   padding: 0;
 50 | }
 51 | 
 52 | li {
 53 |   margin: 0;
 54 |   padding: 0;
 55 |   padding-right: 3px;
 56 |   width: 100%;
 57 | }
 58 | 
 59 | a {
 60 |   text-decoration: none;
 61 |   color: gray;
 62 | }
 63 | 
 64 | a:hover {
 65 |   color: darkgray;
 66 | }
 67 | 
 68 | .content,
 69 | ul {
 70 |   display: flex;
 71 |   flex-wrap: wrap;
 72 |   flex-direction: row;
 73 |   justify-content: space-between;
 74 |   padding: 40px;
 75 | }
 76 | 
 77 | .card {
 78 |   box-shadow: 0 1px 8px 0 rgba(0, 0, 0, 0.2);
 79 |   transition: 0.3s;
 80 |   width: 40%;
 81 |   /* height: 10vh; */
 82 |   padding: 30px;
 83 |   margin-bottom: 20px;
 84 |   overflow-y: scroll;
 85 |   /* display: flex; */
 86 |   /* align-items: center; */
 87 | }
 88 | 
 89 | .card:hover,
 90 | .active {
 91 |   width: 35%;
 92 |   background-color: #efefef;
 93 |     margin-bottom: 0;
 94 |   /* height: 25vh; */
 95 | }
 96 | 
 97 | .card-title {
 98 |   color: #c95252;
 99 | }
100 | 
101 | .card-title,
102 | .description {
103 |   padding: 10px;
104 |   font-family: "iA Writer Duospace, monospace";
105 | }
106 | 
107 | .card > * {
108 |   padding-left: 10px;
109 | }
110 | 
111 | .descriptors {
112 |   display: flex;
113 |   flex-wrap: wrap;
114 | }
115 | 
116 | .descriptors > div {
117 |   width: 33%;
118 |   padding-top: 5px;
119 | }
120 | 
121 | .key {
122 |   color: blue;
123 | }
124 |     </style>
125 | </head>
126 | 
127 | <body>
128 |     <header>
129 |         <h1><a href="">Bashdoc</a>
130 |         </h1>
131 |         <h4>35 functions</h4>
132 |     </header>
133 |     <div class="container">
134 |         <div class="sidebar">
135 |             {{!-- <form><input type="search" /></form> --}}
136 |             <ul>
137 |                 {{#each thedocs}}
138 |                 <li>
139 |                     <a href="#{{short_description}}">{{ this.short_description }}</a>
140 |                 </li>
141 |                 {{/each}}
142 |             </ul>
143 |         </div>
144 |         <div class="content">
145 |             <ul>
146 |                 {{#each thedocs}}
147 |                 <li class="card" name="{{short_description}}" id="{{short_description}}">
148 |                     <div class="card-title">{{ short_description }}</div>
149 |                     <div class="description">{{ long_description }}</div>
150 |                     {{#if params}}
151 |                     <div class="parameters">
152 |                         {{#each params}}
153 |                         <div>
154 |                             <span class="key">{{ key }}</span>: <span>{{ value }}</span>
155 |                         </div>
156 |                         {{/each}}
157 |                     </div>
158 |                     {{/if}} {{#if descriptors}}
159 |                     <div class="descriptors">
160 |                         {{#each descriptors}}
161 |                         <div>
162 |                             <span class="key">{{ key }}</span>: <span>{{ value }}</span>
163 |                         </div>
164 |                         {{/each}}
165 |                     </div>
166 |                     {{/if}} {{#if returns}}
167 |                     <ul class="returns">
168 |                         {{#each returns}}
169 |                         <li>
170 |                             <span class="key">{{ key }}</span>: <span>{{ value }}</span>
171 |                         </li>
172 |                         {{/each}}
173 |                     </ul>
174 |                     {{/if}}
175 |                 </li>
176 |                 {{/each}}
177 |             </ul>
178 | 
179 |         </div>
180 |     </div>
181 | </body>
182 | <script>
183 |     function sleep(ms) {
184 |         return new Promise(resolve => setTimeout(resolve, ms));
185 |     }
186 |     let cards = Array.from(document.getElementsByClassName("card"));
187 |     let as = Array.from(document.getElementsByTagName("a"));
188 |     as.map(tag => tag.addEventListener("click", highlight));
189 |     function highlight(event) {
190 |         let id = event.srcElement.hash;
191 |         cards.map(card => {
192 |             if (`#${card.id}` === id) {
193 |                 let { backgroundColor, width, ...rest } = card.style;
194 |                 card.style.backgroundColor = "#efefef";
195 |                 card.style.width = "35%";
196 |                 sleep(1000).then(() => {
197 |                     card.style.backgroundColor = backgroundColor;
198 |                     card.style.width = width;
199 |                 });
200 |             }
201 |         });
202 |     }
203 | </script>
204 | <style>
205 |     /*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
206 | 
207 |     /* Document
208 |    ========================================================================== */
209 | 
210 |     /**
211 |  * 1. Correct the line height in all browsers.
212 |  * 2. Prevent adjustments of font size after orientation changes in iOS.
213 |  */
214 | 
215 |     html {
216 |         line-height: 1.15;
217 |         /* 1 */
218 |         -webkit-text-size-adjust: 100%;
219 |         /* 2 */
220 |     }
221 | 
222 |     /* Sections
223 |    ========================================================================== */
224 | 
225 |     /**
226 |  * Remove the margin in all browsers.
227 |  */
228 | 
229 |     body {
230 |         margin: 0;
231 |     }
232 | 
233 |     /**
234 |  * Render the `main` element consistently in IE.
235 |  */
236 | 
237 |     main {
238 |         display: block;
239 |     }
240 | 
241 |     /**
242 |  * Correct the font size and margin on `h1` elements within `section` and
243 |  * `article` contexts in Chrome, Firefox, and Safari.
244 |  */
245 | 
246 |     h1 {
247 |         font-size: 2em;
248 |         margin: 0.67em 0;
249 |     }
250 | 
251 |     /* Grouping content
252 |    ========================================================================== */
253 | 
254 |     /**
255 |  * 1. Add the correct box sizing in Firefox.
256 |  * 2. Show the overflow in Edge and IE.
257 |  */
258 | 
259 |     hr {
260 |         box-sizing: content-box;
261 |         /* 1 */
262 |         height: 0;
263 |         /* 1 */
264 |         overflow: visible;
265 |         /* 2 */
266 |     }
267 | 
268 |     /**
269 |  * 1. Correct the inheritance and scaling of font size in all browsers.
270 |  * 2. Correct the odd `em` font sizing in all browsers.
271 |  */
272 | 
273 |     pre {
274 |         font-family: monospace, monospace;
275 |         /* 1 */
276 |         font-size: 1em;
277 |         /* 2 */
278 |     }
279 | 
280 |     /* Text-level semantics
281 |    ========================================================================== */
282 | 
283 |     /**
284 |  * Remove the gray background on active links in IE 10.
285 |  */
286 | 
287 |     a {
288 |         background-color: transparent;
289 |     }
290 | 
291 |     /**
292 |  * 1. Remove the bottom border in Chrome 57-
293 |  * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
294 |  */
295 | 
296 |     abbr[title] {
297 |         border-bottom: none;
298 |         /* 1 */
299 |         text-decoration: underline;
300 |         /* 2 */
301 |         text-decoration: underline dotted;
302 |         /* 2 */
303 |     }
304 | 
305 |     /**
306 |  * Add the correct font weight in Chrome, Edge, and Safari.
307 |  */
308 | 
309 |     b,
310 |     strong {
311 |         font-weight: bolder;
312 |     }
313 | 
314 |     /**
315 |  * 1. Correct the inheritance and scaling of font size in all browsers.
316 |  * 2. Correct the odd `em` font sizing in all browsers.
317 |  */
318 | 
319 |     code,
320 |     kbd,
321 |     samp {
322 |         font-family: monospace, monospace;
323 |         /* 1 */
324 |         font-size: 1em;
325 |         /* 2 */
326 |     }
327 | 
328 |     /**
329 |  * Add the correct font size in all browsers.
330 |  */
331 | 
332 |     small {
333 |         font-size: 80%;
334 |     }
335 | 
336 |     /**
337 |  * Prevent `sub` and `sup` elements from affecting the line height in
338 |  * all browsers.
339 |  */
340 | 
341 |     sub,
342 |     sup {
343 |         font-size: 75%;
344 |         line-height: 0;
345 |         position: relative;
346 |         vertical-align: baseline;
347 |     }
348 | 
349 |     sub {
350 |         bottom: -0.25em;
351 |     }
352 | 
353 |     sup {
354 |         top: -0.5em;
355 |     }
356 | 
357 |     /* Embedded content
358 |    ========================================================================== */
359 | 
360 |     /**
361 |  * Remove the border on images inside links in IE 10.
362 |  */
363 | 
364 |     img {
365 |         border-style: none;
366 |     }
367 | 
368 |     /* Forms
369 |    ========================================================================== */
370 | 
371 |     /**
372 |  * 1. Change the font styles in all browsers.
373 |  * 2. Remove the margin in Firefox and Safari.
374 |  */
375 | 
376 |     button,
377 |     input,
378 |     optgroup,
379 |     select,
380 |     textarea {
381 |         font-family: inherit;
382 |         /* 1 */
383 |         font-size: 100%;
384 |         /* 1 */
385 |         line-height: 1.15;
386 |         /* 1 */
387 |         margin: 0;
388 |         /* 2 */
389 |     }
390 | 
391 |     /**
392 |  * Show the overflow in IE.
393 |  * 1. Show the overflow in Edge.
394 |  */
395 | 
396 |     button,
397 |     input {
398 |         /* 1 */
399 |         overflow: visible;
400 |     }
401 | 
402 |     /**
403 |  * Remove the inheritance of text transform in Edge, Firefox, and IE.
404 |  * 1. Remove the inheritance of text transform in Firefox.
405 |  */
406 | 
407 |     button,
408 |     select {
409 |         /* 1 */
410 |         text-transform: none;
411 |     }
412 | 
413 |     /**
414 |  * Correct the inability to style clickable types in iOS and Safari.
415 |  */
416 | 
417 |     button,
418 |     [type="button"],
419 |     [type="reset"],
420 |     [type="submit"] {
421 |         -webkit-appearance: button;
422 |     }
423 | 
424 |     /**
425 |  * Remove the inner border and padding in Firefox.
426 |  */
427 | 
428 |     button::-moz-focus-inner,
429 |     [type="button"]::-moz-focus-inner,
430 |     [type="reset"]::-moz-focus-inner,
431 |     [type="submit"]::-moz-focus-inner {
432 |         border-style: none;
433 |         padding: 0;
434 |     }
435 | 
436 |     /**
437 |  * Restore the focus styles unset by the previous rule.
438 |  */
439 | 
440 |     button:-moz-focusring,
441 |     [type="button"]:-moz-focusring,
442 |     [type="reset"]:-moz-focusring,
443 |     [type="submit"]:-moz-focusring {
444 |         outline: 1px dotted ButtonText;
445 |     }
446 | 
447 |     /**
448 |  * Correct the padding in Firefox.
449 |  */
450 | 
451 |     fieldset {
452 |         padding: 0.35em 0.75em 0.625em;
453 |     }
454 | 
455 |     /**
456 |  * 1. Correct the text wrapping in Edge and IE.
457 |  * 2. Correct the color inheritance from `fieldset` elements in IE.
458 |  * 3. Remove the padding so developers are not caught out when they zero out
459 |  *    `fieldset` elements in all browsers.
460 |  */
461 | 
462 |     legend {
463 |         box-sizing: border-box;
464 |         /* 1 */
465 |         color: inherit;
466 |         /* 2 */
467 |         display: table;
468 |         /* 1 */
469 |         max-width: 100%;
470 |         /* 1 */
471 |         padding: 0;
472 |         /* 3 */
473 |         white-space: normal;
474 |         /* 1 */
475 |     }
476 | 
477 |     /**
478 |  * Add the correct vertical alignment in Chrome, Firefox, and Opera.
479 |  */
480 | 
481 |     progress {
482 |         vertical-align: baseline;
483 |     }
484 | 
485 |     /**
486 |  * Remove the default vertical scrollbar in IE 10+.
487 |  */
488 | 
489 |     textarea {
490 |         overflow: auto;
491 |     }
492 | 
493 |     /**
494 |  * 1. Add the correct box sizing in IE 10.
495 |  * 2. Remove the padding in IE 10.
496 |  */
497 | 
498 |     [type="checkbox"],
499 |     [type="radio"] {
500 |         box-sizing: border-box;
501 |         /* 1 */
502 |         padding: 0;
503 |         /* 2 */
504 |     }
505 | 
506 |     /**
507 |  * Correct the cursor style of increment and decrement buttons in Chrome.
508 |  */
509 | 
510 |     [type="number"]::-webkit-inner-spin-button,
511 |     [type="number"]::-webkit-outer-spin-button {
512 |         height: auto;
513 |     }
514 | 
515 |     /**
516 |  * 1. Correct the odd appearance in Chrome and Safari.
517 |  * 2. Correct the outline style in Safari.
518 |  */
519 | 
520 |     [type="search"] {
521 |         -webkit-appearance: textfield;
522 |         /* 1 */
523 |         outline-offset: -2px;
524 |         /* 2 */
525 |     }
526 | 
527 |     /**
528 |  * Remove the inner padding in Chrome and Safari on macOS.
529 |  */
530 | 
531 |     [type="search"]::-webkit-search-decoration {
532 |         -webkit-appearance: none;
533 |     }
534 | 
535 |     /**
536 |  * 1. Correct the inability to style clickable types in iOS and Safari.
537 |  * 2. Change font properties to `inherit` in Safari.
538 |  */
539 | 
540 |     ::-webkit-file-upload-button {
541 |         -webkit-appearance: button;
542 |         /* 1 */
543 |         font: inherit;
544 |         /* 2 */
545 |     }
546 | 
547 |     /* Interactive
548 |    ========================================================================== */
549 | 
550 |     /*
551 |  * Add the correct display in Edge, IE 10+, and Firefox.
552 |  */
553 | 
554 |     details {
555 |         display: block;
556 |     }
557 | 
558 |     /*
559 |  * Add the correct display in all browsers.
560 |  */
561 | 
562 |     summary {
563 |         display: list-item;
564 |     }
565 | 
566 |     /* Misc
567 |    ========================================================================== */
568 | 
569 |     /**
570 |  * Add the correct display in IE 10+.
571 |  */
572 | 
573 |     template {
574 |         display: none;
575 |     }
576 | 
577 |     /**
578 |  * Add the correct display in IE 10.
579 |  */
580 | 
581 |     [hidden] {
582 |         display: none;
583 |     }
584 | </style>
585 | 
586 | </html>


--------------------------------------------------------------------------------