-
-
Notifications
You must be signed in to change notification settings - Fork 166
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This is built around Arborist and will be the place where we eventually are able to generate "patches" for an arbitrary change. My goal with this was to just create a basic command, in this case `show-tree`, which wraps Arborist and provides a basic "test case" for us to verify that the library works. There is a basic fixture that I committed here -- an arbitrary NPM project from my machine -- that we can use for testing. In the future, I hope to add in the commands to actually modify the tree to "update" a package to a given version.
- Loading branch information
Showing
34 changed files
with
3,514 additions
and
665 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2019 Salesforce | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| <!-- | ||
| ~ Copyright by LunaSec (owned by Refinery Labs, Inc) | ||
| ~ | ||
| ~ Licensed under the Creative Commons Attribution-ShareAlike 4.0 International | ||
| ~ (the "License"); you may not use this file except in compliance with the | ||
| ~ License. You may obtain a copy of the License at | ||
| ~ | ||
| ~ https://creativecommons.org/licenses/by-sa/4.0/legalcode | ||
| ~ | ||
| ~ See the License for the specific language governing permissions and | ||
| ~ limitations under the License. | ||
| ~ | ||
| --> | ||
| lunatrace-npm-cli | ||
| ================= | ||
|
|
||
| This is the LunaTrace CLI for NPM and Yarn. It is basically a wrapper around the "Arborist" NPM library. | ||
|
|
||
| <!-- toc --> | ||
| * [Usage](#usage) | ||
| * [Commands](#commands) | ||
| <!-- tocstop --> | ||
| # Usage | ||
| <!-- usage --> | ||
| ```sh-session | ||
| $ npm install -g @lunasec/lunatrace-npm-cli | ||
| $ lunatrace-npm-cli COMMAND | ||
| running command... | ||
| $ lunatrace-npm-cli (--version) | ||
| lunatrace-npm-cli/0.0.0 darwin-x64 node-v16.13.1 | ||
| $ lunatrace-npm-cli --help [COMMAND] | ||
| USAGE | ||
| $ lunatrace-npm-cli COMMAND | ||
| ... | ||
| ``` | ||
| <!-- usagestop --> | ||
| # Commands | ||
| <!-- commands --> | ||
| * [`lunatrace-npm-cli show-tree /path/to/tree`](#show-tree) | ||
|
|
||
| ## `show-tree` | ||
|
|
||
| Prints out the NPM dependency tree for the specified path. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ lunatrace-npm-cli show-tree [PROJECT_PATH] | ||
| ARGUMENTS | ||
| PROJECT_PATH Folder that should contain a package.json and package-lock.json | ||
| DESCRIPTION | ||
| Prints out the NPM dependency tree for the specified path. | ||
| EXAMPLES | ||
| $ lunatrace-npm-cli show-tree /path/to/tree | ||
| Package tree: | ||
| [email protected] | ||
| ... big tree of data ... | ||
| ``` | ||
|
|
||
| ### Built With | ||
|
|
||
| We are using `oclif` to build this CLI. It is a great tool to build CLIs with Node.js and TypeScript! | ||
|
|
||
| [](https://oclif.io) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| const oclif = require('@oclif/core') | ||
|
|
||
| const path = require('path') | ||
| const project = path.join(__dirname, '..', 'tsconfig.json') | ||
|
|
||
| // In dev mode -> use ts-node and dev plugins | ||
| process.env.NODE_ENV = 'development' | ||
|
|
||
| require('ts-node').register({project}) | ||
|
|
||
| // In dev mode, always show stack traces | ||
| oclif.settings.debug = true; | ||
|
|
||
| // Start the CLI | ||
| oclif.run().then(oclif.flush).catch(oclif.Errors.handle) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| @echo off | ||
|
|
||
| node "%~dp0\dev" %* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| const oclif = require('@oclif/core') | ||
|
|
||
| oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle')) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| @echo off | ||
|
|
||
| node "%~dp0\run" %* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /* | ||
| * Copyright 2023 by LunaSec (owned by Refinery Labs, Inc) | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
| /* | ||
| * Copyright by LunaSec (owned by Refinery Labs, Inc) | ||
| * | ||
| * Licensed under the Business Source License v1.1 | ||
| * (the "License"); you may not use this file except in compliance with the | ||
| * License. You may obtain a copy of the License at | ||
| * | ||
| * https://github.com/lunasec-io/lunasec/blob/master/licenses/BSL-LunaTrace.txt | ||
| * | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
| /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */ | ||
| module.exports = { | ||
| preset: 'ts-jest', | ||
| testEnvironment: 'node', | ||
| modulePathIgnorePatterns: ["dist", "bin"] | ||
| }; |
Oops, something went wrong.