├── .github └── FUNDING.yml ├── .gitignore ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── basedirectory.tar.gz ├── index.js ├── package-lock.json └── package.json /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [sdras] 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### OSX ### 2 | *.DS_Store 3 | .AppleDouble 4 | .LSOverride 5 | 6 | ## Don't add in the base-directory tree that might have been made 7 | base-directory-tree 8 | 9 | # Icon must end with two 10 | Icon 11 | # Thumbnails 12 | ._* 13 | # Files that might appear in the root of a volume 14 | .DocumentRevisions-V100 15 | .fseventsd 16 | .Spotlight-V100 17 | .TemporaryItems 18 | .Trashes 19 | .VolumeIcon.icns 20 | .com.apple.timemachine.donotpresent 21 | # Directories potentially created on remote AFP share 22 | .AppleDB 23 | .AppleDesktop 24 | Network Trash Folder 25 | Temporary Items 26 | .apdisk 27 | 28 | ### Node ### 29 | # Logs 30 | logs 31 | *.log 32 | npm-debug.log* 33 | 34 | # Runtime data 35 | pids 36 | *.pid 37 | *.seed 38 | *.pid.lock 39 | 40 | # Directory for instrumented libs generated by jscoverage/JSCover 41 | lib-cov 42 | 43 | # Coverage directory used by tools like istanbul 44 | coverage 45 | 46 | # nyc test coverage 47 | .nyc_output 48 | 49 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 50 | .grunt 51 | 52 | # node-waf configuration 53 | .lock-wscript 54 | 55 | # Compiled binary addons (http://nodejs.org/api/addons.html) 56 | build/Release 57 | 58 | # Dependency directories 59 | node_modules 60 | jspm_packages 61 | 62 | # Optional npm cache directory 63 | .npm 64 | 65 | # Optional eslint cache 66 | .eslintcache 67 | 68 | # Optional REPL history 69 | .node_repl_history 70 | 71 | # Output of 'npm pack' 72 | *.tgz 73 | 74 | # Yarn Integrity file 75 | .yarn-integrity 76 | 77 | # Nuxt build 78 | .nuxt 79 | 80 | # Nuxt generate 81 | dist -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ### 1.3.3 4 | 5 | #### Bug Fixes: 6 | 7 | - [#14](https://github.com/sdras/project-explorer/issues/17) Fix silent error when no .gitignore is included 8 | 9 | ### 1.3.2 10 | 11 | #### Improvement: 12 | 13 | - Add in CONTRIBUTING.md 14 | 15 | ### 1.3.1 16 | 17 | #### Bug Fixes: 18 | 19 | - [#14](https://github.com/sdras/project-explorer/issues/14) Exclude files .gitignore, .git, and the created base-directory-tree 20 | 21 | ### 1.3.0 22 | 23 | #### Improvement: 24 | 25 | - [#8](https://github.com/sdras/project-explorer/issues/8) Exclude files listed in .gitignore 26 | 27 | ### 1.2.0 28 | 29 | #### Improvement: 30 | 31 | - Move the base-directory-tree tarball to Vue CLI 3 32 | 33 | #### Bug Fixes: 34 | 35 | - [#4](https://github.com/sdras/project-explorer/issues/4) Fix the arrow placement 36 | 37 | ### 1.1.0 38 | 39 | #### Bug Fixes: 40 | 41 | - [#2](https://github.com/sdras/project-explorer/issues/2) Rename the command, tree is already taken, change to pexx 42 | 43 | ### 1.0.7 44 | 45 | Initial Release 46 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. 6 | 7 | ## Our Standards 8 | 9 | Examples of behavior that contributes to creating a positive environment include: 10 | 11 | * Using welcoming and inclusive language 12 | * Being respectful of differing viewpoints and experiences 13 | * Gracefully accepting constructive criticism 14 | * Focusing on what is best for the community 15 | * Showing empathy towards other community members 16 | 17 | Examples of unacceptable behavior by participants include: 18 | 19 | * The use of sexualized language or imagery and unwelcome sexual attention or advances 20 | * Trolling, insulting/derogatory comments, and personal or political attacks 21 | * Public or private harassment 22 | * Publishing others' private information, such as a physical or electronic address, without explicit permission 23 | * Other conduct which could reasonably be considered inappropriate in a professional setting 24 | 25 | ## Our Responsibilities 26 | 27 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. 28 | 29 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. 30 | 31 | ## Scope 32 | 33 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. 34 | 35 | ## Enforcement 36 | 37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at sarah.drasner@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. 38 | 39 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. 40 | 41 | ## Attribution 42 | 43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] 44 | 45 | [homepage]: http://contributor-covenant.org 46 | [version]: http://contributor-covenant.org/version/1/4/ 47 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to contribute 2 | 3 | 🎉🤘🍻 First of all, thank you so much for wanting to contribute to this project! 4 | 5 | I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition. 6 | 7 | ## Testing locally 8 | 9 | If you've already installed project-explorer globally, you will need to distinguish when you want to test local changes. One way to do so is: 10 | 11 | ``` 12 | node index.js testing 13 | ``` 14 | 15 | I'm using chalk to color the terminal output so if you'd like to console.log changes in a color you can see clearly you can do so like this: 16 | 17 | ``` 18 | console.log(chalk.cyan(`testing!`)) 19 | ``` 20 | 21 | ## Submitting changes 22 | 23 | Please send a [GitHub Pull Request to project-explorer](https://github.com/sdras/project-explorer/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). Always write a clear log message for your commits. 24 | 25 | Thanks, 26 | Sarah Drasner 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 Sarah Drasner 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 | # 🎋 Project Explorer 2 | 3 | > Check out the site: [https://sdras.github.io/project-explorer-site/](https://sdras.github.io/project-explorer-site/) 4 | 5 | Create a tree visualization of any project with this CLI tool. When ramping people up on an existing codebase, there's often a lot of state they have to understand about the project- where everything is, where everything starts, exceptional files. With this tool, you can generate a visualization of any project, as well modify certain directories to be open, or have notes that people can read through easily. 6 | 7 | ## Installation 8 | 9 | ``` 10 | npm i -g project-explorer 11 | ``` 12 | 13 | Here's an example of what we'll be generating: 14 | 15 | ![demo-image](https://s3-us-west-2.amazonaws.com/s.cdpn.io/28963/vue-directory.png) 16 | 17 | A [working example of this exists here](https://sdras.github.io/vue-directory-tree/). I created this for Vue core off of notes taken at a core meeting as Evan You walked us through some of the file structure. 18 | 19 | ### Prerequisites: 20 | - You need to be running Node 8 or higher 21 | - You have to have Yarn installed. 22 | 23 | ## Usage: 24 | > _To create the visualization in the same folder as your project_: 25 | 1. Go into the directory of a project you'd like to document, and run the first command, `pexx nameofyourproject`. 26 | 2. When prompted for your path, write `.` or `./` 27 | 3. Magic happens! ✨ (but it takes a minute ⏰) 28 | 29 | --- 30 | 31 | > _To create the visualization in a separate folder_: 32 | 1. Go into the directory of a project you'd like to document, and run `pwd` in your terminal to get the path 33 | 2. Create a new folder to run this CLI in. 34 | 3. Run the first command, `pexx nameofyourproject`. 35 | 4. Then paste in the output of pwd as your path when the CLI prompts you for it. 36 | 5. Magic happens! ✨ (but it takes a minute ⏰) 37 | 38 | --- 39 | 40 | ``` 41 | $ pexx nameofyourproject 42 | > path: ./ (or whatever your pwd output is) 43 | ‣ Name of Project: nameofyourproject 44 | ‣ Path: ./ 45 | ``` 46 | 47 | - Replace `nameofyourproject` with the name you'd like to give your project 48 | - Files in `.gitignore` will be ignored in the build. We've also removed `.gitignore`, `.git`, and the `base-directory-tree` that this project will generate. 49 | - Path can either be the current directory or you can use `pwd` in another local directory of choice. I recommend this option as you might want these files and this documentation in another folder. 50 | 51 | This will kick off the processes that will build the directory trees, the UI for traversing, and give you a little example to start with too :) It will even kick off the server for you. 52 | 53 | ## Open directories 54 | 55 | You can specify what directories you would like to be open when a user first visits by adding them to the `opened` array in `base-directory-tree/src/store`. 56 | 57 | ## Comments 58 | 59 | You can add comments for the different files by adding them to the `comments` object in `base-directory-tree/src/store`. You will specify it using the path as the key and the comment as the value, like this: 60 | 61 | ``` 62 | `READMEexample`: `This is an example of how a note is made! You can write the pathname of any file and the note will appear ☺️. You can delete this now.` 63 | ``` 64 | 65 | ## Github link 66 | 67 | You can point the github logo link to your own repo by updating the `github` string in `base-directory-tree/src/store`. 68 | 69 | (Basically all the state you need is probably in the Vuex store. 😉) 70 | 71 | ## Contributing 72 | 73 | Contributions are welcome! 🤘 Please head over to `CONTRIBUTING.md` for more information. 74 | 75 | 🥂 Thanks for using this project! I hope it's helpful. If you see ways to improve it, PRs are welcome. 76 | 77 | Twitter: [sarah_edo](https://twitter.com/sarah_edo) 78 | -------------------------------------------------------------------------------- /basedirectory.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sdras/project-explorer/94461badb73229f1bb778ca5fd9fc7ab9166b079/basedirectory.tar.gz -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | const program = require('commander'), 3 | co = require('co'), 4 | prompt = require('co-prompt'), 5 | chalk = require('chalk'), 6 | dirTree = require('directory-tree'), 7 | shell = require('shelljs'), 8 | targz = require('targz'), 9 | isGlob = require('is-glob'), 10 | globToRegExp = require('glob-to-regexp'), 11 | path = require('path'), 12 | fs = require('fs') 13 | 14 | const writeFile = (tree, name, cb) => { 15 | // we want to name the initial directory properly and later we'll make sure it's open 16 | tree.name = name 17 | // we add this note so that people can see how to add comments. 18 | // feel free to delete this part if you want to eliminate the example 19 | tree.children.push({ 20 | path: 'READMEexample', 21 | name: 'READMEexample', 22 | type: 'file' 23 | }) 24 | const fullTree = `const tree = ${JSON.stringify(tree, null, 2)} 25 | export { tree }` 26 | 27 | const nameDir = `const name = '${name}' 28 | export { name }` 29 | 30 | fs.writeFile('./base-directory-tree/src/tree.js', fullTree, 'utf8', err => { 31 | if (err) throw err 32 | fs.writeFile('./base-directory-tree/src/name.js', nameDir, 'utf8', err => { 33 | if (err) throw err 34 | console.log( 35 | chalk.yellow(`✨ Your files were saved, now let's build it out! ✨`) 36 | ) 37 | console.log('Hang tight, this might take a minute.') 38 | cb() 39 | }) 40 | }) 41 | } 42 | 43 | const gitignoreRegex = (root) => { 44 | let fileContents 45 | try { 46 | fileContents = fs.readFileSync(path.join(root, '.gitignore'), 'utf8') 47 | } catch (err) { return [] } 48 | return fileContents.split(/\r?\n/) 49 | .filter(line => line.trim() !== '' && line.trim().charAt(0) !== '#') 50 | .map(line => { 51 | const pattern = line.trim() 52 | return isGlob(pattern) ? globToRegExp(pattern) : RegExp(pattern.replace(/\/$/, '')) 53 | }) 54 | } 55 | 56 | program 57 | .arguments('') 58 | .option('-p, --path ', 'The directory used for the project explorer') 59 | .option('-wf, --writefile', 'Writetofile', writeFile) 60 | .action(name => { 61 | co(function*() { 62 | const pathDir = yield prompt('path: ') 63 | console.log(chalk.cyan('‣ Name of Project: ') + name) 64 | console.log(chalk.cyan('‣ Path: ') + pathDir) 65 | 66 | //take the gitignored regex array to exclude and add a couple more files, like the base-directory-tree we created. 67 | const gitignoredArr = gitignoreRegex(pathDir) 68 | gitignoredArr.push(/\.gitignore/, /base-directory-tree/, /\.git/) 69 | 70 | const tree = dirTree(pathDir, { 71 | exclude: gitignoredArr 72 | }) 73 | 74 | if (tree === null) { 75 | console.log( 76 | chalk.red( 77 | `Warning! ${pathDir} is not a directory usable by the project explorer. Perhaps try using pwd to generate the path for you.` 78 | ) 79 | ) 80 | process.exit(1) 81 | } 82 | 83 | targz.decompress( 84 | { 85 | src: path.join(__dirname, 'basedirectory.tar.gz'), 86 | dest: '.' 87 | }, 88 | function(err) { 89 | if (err) { 90 | console.log(err) 91 | } else { 92 | // write the files and call the shell commands to kick the project off 93 | writeFile(tree, name, err => { 94 | if (err) { 95 | console.log(chalk.red(err)) 96 | process.exit(1) 97 | } 98 | shell.cd('base-directory-tree') 99 | shell.exec('yarn') 100 | console.log( 101 | chalk.cyan( 102 | `🎸 Done! Built with success! Now let's get you a server.` 103 | ) 104 | ) 105 | shell.exec('yarn serve') 106 | }) 107 | } 108 | } 109 | ) 110 | }) 111 | }) 112 | .parse(process.argv) 113 | -------------------------------------------------------------------------------- /package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "project-explorer", 3 | "version": "1.2.0", 4 | "lockfileVersion": 1, 5 | "requires": true, 6 | "dependencies": { 7 | "ansi-styles": { 8 | "version": "3.2.1", 9 | "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", 10 | "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", 11 | "requires": { 12 | "color-convert": "1.9.3" 13 | } 14 | }, 15 | "balanced-match": { 16 | "version": "1.0.0", 17 | "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", 18 | "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=" 19 | }, 20 | "bl": { 21 | "version": "1.2.2", 22 | "resolved": "https://registry.npmjs.org/bl/-/bl-1.2.2.tgz", 23 | "integrity": "sha512-e8tQYnZodmebYDWGH7KMRvtzKXaJHx3BbilrgZCfvyLUYdKpK1t5PSPmpkny/SgiTSCnjfLW7v5rlONXVFkQEA==", 24 | "requires": { 25 | "readable-stream": "2.3.6", 26 | "safe-buffer": "5.1.2" 27 | } 28 | }, 29 | "brace-expansion": { 30 | "version": "1.1.11", 31 | "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", 32 | "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", 33 | "requires": { 34 | "balanced-match": "1.0.0", 35 | "concat-map": "0.0.1" 36 | } 37 | }, 38 | "buffer-alloc": { 39 | "version": "1.2.0", 40 | "resolved": "https://registry.npmjs.org/buffer-alloc/-/buffer-alloc-1.2.0.tgz", 41 | "integrity": "sha512-CFsHQgjtW1UChdXgbyJGtnm+O/uLQeZdtbDo8mfUgYXCHSM1wgrVxXm6bSyrUuErEb+4sYVGCzASBRot7zyrow==", 42 | "requires": { 43 | "buffer-alloc-unsafe": "1.1.0", 44 | "buffer-fill": "1.0.0" 45 | } 46 | }, 47 | "buffer-alloc-unsafe": { 48 | "version": "1.1.0", 49 | "resolved": "https://registry.npmjs.org/buffer-alloc-unsafe/-/buffer-alloc-unsafe-1.1.0.tgz", 50 | "integrity": "sha512-TEM2iMIEQdJ2yjPJoSIsldnleVaAk1oW3DBVUykyOLsEsFmEc9kn+SFFPz+gl54KQNxlDnAwCXosOS9Okx2xAg==" 51 | }, 52 | "buffer-fill": { 53 | "version": "1.0.0", 54 | "resolved": "https://registry.npmjs.org/buffer-fill/-/buffer-fill-1.0.0.tgz", 55 | "integrity": "sha1-+PeLdniYiO858gXNY39o5wISKyw=" 56 | }, 57 | "chalk": { 58 | "version": "2.4.1", 59 | "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.1.tgz", 60 | "integrity": "sha512-ObN6h1v2fTJSmUXoS3nMQ92LbDK9be4TV+6G+omQlGJFdcUX5heKi1LZ1YnRMIgwTLEj3E24bT6tYni50rlCfQ==", 61 | "requires": { 62 | "ansi-styles": "3.2.1", 63 | "escape-string-regexp": "1.0.5", 64 | "supports-color": "5.5.0" 65 | } 66 | }, 67 | "chownr": { 68 | "version": "1.0.1", 69 | "resolved": "https://registry.npmjs.org/chownr/-/chownr-1.0.1.tgz", 70 | "integrity": "sha1-4qdQQqlVGQi+vSW4Uj1fl2nXkYE=" 71 | }, 72 | "co": { 73 | "version": "4.6.0", 74 | "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", 75 | "integrity": "sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ=" 76 | }, 77 | "co-prompt": { 78 | "version": "1.0.0", 79 | "resolved": "https://registry.npmjs.org/co-prompt/-/co-prompt-1.0.0.tgz", 80 | "integrity": "sha1-+zcOntrEhXayenMv5dfyHZ/G5vY=", 81 | "requires": { 82 | "keypress": "0.2.1" 83 | } 84 | }, 85 | "color-convert": { 86 | "version": "1.9.3", 87 | "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", 88 | "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", 89 | "requires": { 90 | "color-name": "1.1.3" 91 | } 92 | }, 93 | "color-name": { 94 | "version": "1.1.3", 95 | "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", 96 | "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=" 97 | }, 98 | "commander": { 99 | "version": "2.18.0", 100 | "resolved": "https://registry.npmjs.org/commander/-/commander-2.18.0.tgz", 101 | "integrity": "sha512-6CYPa+JP2ftfRU2qkDK+UTVeQYosOg/2GbcjIcKPHfinyOLPVGXu/ovN86RP49Re5ndJK1N0kuiidFFuepc4ZQ==" 102 | }, 103 | "concat-map": { 104 | "version": "0.0.1", 105 | "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", 106 | "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=" 107 | }, 108 | "core-util-is": { 109 | "version": "1.0.2", 110 | "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", 111 | "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=" 112 | }, 113 | "directory-tree": { 114 | "version": "2.1.0", 115 | "resolved": "https://registry.npmjs.org/directory-tree/-/directory-tree-2.1.0.tgz", 116 | "integrity": "sha1-4MGmb2JUgar31gN0Hw09k83Uhno=" 117 | }, 118 | "end-of-stream": { 119 | "version": "1.4.1", 120 | "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.1.tgz", 121 | "integrity": "sha512-1MkrZNvWTKCaigbn+W15elq2BB/L22nqrSY5DKlo3X6+vclJm8Bb5djXJBmEX6fS3+zCh/F4VBK5Z2KxJt4s2Q==", 122 | "requires": { 123 | "once": "1.4.0" 124 | } 125 | }, 126 | "escape-string-regexp": { 127 | "version": "1.0.5", 128 | "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", 129 | "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=" 130 | }, 131 | "fs-constants": { 132 | "version": "1.0.0", 133 | "resolved": "https://registry.npmjs.org/fs-constants/-/fs-constants-1.0.0.tgz", 134 | "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==" 135 | }, 136 | "fs.realpath": { 137 | "version": "1.0.0", 138 | "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", 139 | "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=" 140 | }, 141 | "glob": { 142 | "version": "7.1.3", 143 | "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", 144 | "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", 145 | "requires": { 146 | "fs.realpath": "1.0.0", 147 | "inflight": "1.0.6", 148 | "inherits": "2.0.3", 149 | "minimatch": "3.0.4", 150 | "once": "1.4.0", 151 | "path-is-absolute": "1.0.1" 152 | } 153 | }, 154 | "glob-to-regexp": { 155 | "version": "0.4.0", 156 | "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.4.0.tgz", 157 | "integrity": "sha512-fyPCII4vn9Gvjq2U/oDAfP433aiE64cyP/CJjRJcpVGjqqNdioUYn9+r0cSzT1XPwmGAHuTT7iv+rQT8u/YHKQ==" 158 | }, 159 | "has-flag": { 160 | "version": "3.0.0", 161 | "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", 162 | "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=" 163 | }, 164 | "inflight": { 165 | "version": "1.0.6", 166 | "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", 167 | "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", 168 | "requires": { 169 | "once": "1.4.0", 170 | "wrappy": "1.0.2" 171 | } 172 | }, 173 | "inherits": { 174 | "version": "2.0.3", 175 | "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", 176 | "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" 177 | }, 178 | "interpret": { 179 | "version": "1.1.0", 180 | "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.1.0.tgz", 181 | "integrity": "sha1-ftGxQQxqDg94z5XTuEQMY/eLhhQ=" 182 | }, 183 | "is-extglob": { 184 | "version": "2.1.1", 185 | "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", 186 | "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=" 187 | }, 188 | "is-glob": { 189 | "version": "4.0.0", 190 | "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.0.tgz", 191 | "integrity": "sha1-lSHHaEXMJhCoUgPd8ICpWML/q8A=", 192 | "requires": { 193 | "is-extglob": "2.1.1" 194 | } 195 | }, 196 | "isarray": { 197 | "version": "1.0.0", 198 | "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", 199 | "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=" 200 | }, 201 | "keypress": { 202 | "version": "0.2.1", 203 | "resolved": "https://registry.npmjs.org/keypress/-/keypress-0.2.1.tgz", 204 | "integrity": "sha1-HoBFQlABjbrUw/6USX1uZ7YmnHc=" 205 | }, 206 | "minimatch": { 207 | "version": "3.0.4", 208 | "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", 209 | "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", 210 | "requires": { 211 | "brace-expansion": "1.1.11" 212 | } 213 | }, 214 | "minimist": { 215 | "version": "0.0.8", 216 | "resolved": "http://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz", 217 | "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=" 218 | }, 219 | "mkdirp": { 220 | "version": "0.5.1", 221 | "resolved": "http://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", 222 | "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", 223 | "requires": { 224 | "minimist": "0.0.8" 225 | } 226 | }, 227 | "once": { 228 | "version": "1.4.0", 229 | "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", 230 | "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", 231 | "requires": { 232 | "wrappy": "1.0.2" 233 | } 234 | }, 235 | "path-is-absolute": { 236 | "version": "1.0.1", 237 | "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", 238 | "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=" 239 | }, 240 | "path-parse": { 241 | "version": "1.0.6", 242 | "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz", 243 | "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==" 244 | }, 245 | "process-nextick-args": { 246 | "version": "2.0.0", 247 | "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.0.tgz", 248 | "integrity": "sha512-MtEC1TqN0EU5nephaJ4rAtThHtC86dNN9qCuEhtshvpVBkAW5ZO7BASN9REnF9eoXGcRub+pFuKEpOHE+HbEMw==" 249 | }, 250 | "pump": { 251 | "version": "1.0.3", 252 | "resolved": "https://registry.npmjs.org/pump/-/pump-1.0.3.tgz", 253 | "integrity": "sha512-8k0JupWme55+9tCVE+FS5ULT3K6AbgqrGa58lTT49RpyfwwcGedHqaC5LlQNdEAumn/wFsu6aPwkuPMioy8kqw==", 254 | "requires": { 255 | "end-of-stream": "1.4.1", 256 | "once": "1.4.0" 257 | } 258 | }, 259 | "readable-stream": { 260 | "version": "2.3.6", 261 | "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz", 262 | "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==", 263 | "requires": { 264 | "core-util-is": "1.0.2", 265 | "inherits": "2.0.3", 266 | "isarray": "1.0.0", 267 | "process-nextick-args": "2.0.0", 268 | "safe-buffer": "5.1.2", 269 | "string_decoder": "1.1.1", 270 | "util-deprecate": "1.0.2" 271 | } 272 | }, 273 | "rechoir": { 274 | "version": "0.6.2", 275 | "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", 276 | "integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=", 277 | "requires": { 278 | "resolve": "1.8.1" 279 | } 280 | }, 281 | "resolve": { 282 | "version": "1.8.1", 283 | "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.8.1.tgz", 284 | "integrity": "sha512-AicPrAC7Qu1JxPCZ9ZgCZlY35QgFnNqc+0LtbRNxnVw4TXvjQ72wnuL9JQcEBgXkI9JM8MsT9kaQoHcpCRJOYA==", 285 | "requires": { 286 | "path-parse": "1.0.6" 287 | } 288 | }, 289 | "safe-buffer": { 290 | "version": "5.1.2", 291 | "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", 292 | "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==" 293 | }, 294 | "shelljs": { 295 | "version": "0.8.2", 296 | "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.2.tgz", 297 | "integrity": "sha512-pRXeNrCA2Wd9itwhvLp5LZQvPJ0wU6bcjaTMywHHGX5XWhVN2nzSu7WV0q+oUY7mGK3mgSkDDzP3MgjqdyIgbQ==", 298 | "requires": { 299 | "glob": "7.1.3", 300 | "interpret": "1.1.0", 301 | "rechoir": "0.6.2" 302 | } 303 | }, 304 | "string_decoder": { 305 | "version": "1.1.1", 306 | "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", 307 | "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", 308 | "requires": { 309 | "safe-buffer": "5.1.2" 310 | } 311 | }, 312 | "supports-color": { 313 | "version": "5.5.0", 314 | "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", 315 | "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", 316 | "requires": { 317 | "has-flag": "3.0.0" 318 | } 319 | }, 320 | "tar-fs": { 321 | "version": "1.16.3", 322 | "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-1.16.3.tgz", 323 | "integrity": "sha512-NvCeXpYx7OsmOh8zIOP/ebG55zZmxLE0etfWRbWok+q2Qo8x/vOR/IJT1taADXPe+jsiu9axDb3X4B+iIgNlKw==", 324 | "requires": { 325 | "chownr": "1.0.1", 326 | "mkdirp": "0.5.1", 327 | "pump": "1.0.3", 328 | "tar-stream": "1.6.1" 329 | } 330 | }, 331 | "tar-stream": { 332 | "version": "1.6.1", 333 | "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-1.6.1.tgz", 334 | "integrity": "sha512-IFLM5wp3QrJODQFPm6/to3LJZrONdBY/otxcvDIQzu217zKye6yVR3hhi9lAjrC2Z+m/j5oDxMPb1qcd8cIvpA==", 335 | "requires": { 336 | "bl": "1.2.2", 337 | "buffer-alloc": "1.2.0", 338 | "end-of-stream": "1.4.1", 339 | "fs-constants": "1.0.0", 340 | "readable-stream": "2.3.6", 341 | "to-buffer": "1.1.1", 342 | "xtend": "4.0.1" 343 | } 344 | }, 345 | "targz": { 346 | "version": "1.0.1", 347 | "resolved": "https://registry.npmjs.org/targz/-/targz-1.0.1.tgz", 348 | "integrity": "sha1-j3alI2lM3t+7XWCkB2/27uzFOY8=", 349 | "requires": { 350 | "tar-fs": "1.16.3" 351 | } 352 | }, 353 | "to-buffer": { 354 | "version": "1.1.1", 355 | "resolved": "https://registry.npmjs.org/to-buffer/-/to-buffer-1.1.1.tgz", 356 | "integrity": "sha512-lx9B5iv7msuFYE3dytT+KE5tap+rNYw+K4jVkb9R/asAb+pbBSM17jtunHplhBe6RRJdZx3Pn2Jph24O32mOVg==" 357 | }, 358 | "util-deprecate": { 359 | "version": "1.0.2", 360 | "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", 361 | "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=" 362 | }, 363 | "wrappy": { 364 | "version": "1.0.2", 365 | "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", 366 | "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=" 367 | }, 368 | "xtend": { 369 | "version": "4.0.1", 370 | "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.1.tgz", 371 | "integrity": "sha1-pcbVMr5lbiPbgg77lDofBJmNY68=" 372 | } 373 | } 374 | } 375 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "project-explorer", 3 | "version": "1.3.3", 4 | "description": "Create a navigable directory tree visualization of your project", 5 | "main": "index.js", 6 | "keywords": [ 7 | "tree, visualization, directory, notes, CLI, tool" 8 | ], 9 | "bin": { 10 | "pexx": "./index.js" 11 | }, 12 | "author": "sdras", 13 | "license": "MIT", 14 | "dependencies": { 15 | "chalk": "^2.4.1", 16 | "co": "^4.6.0", 17 | "co-prompt": "^1.0.0", 18 | "commander": "^2.18.0", 19 | "directory-tree": "^2.1.0", 20 | "glob-to-regexp": "^0.4.0", 21 | "is-glob": "^4.0.0", 22 | "shelljs": "^0.8.2", 23 | "targz": "^1.0.1" 24 | } 25 | } 26 | --------------------------------------------------------------------------------