-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
48 changed files
with
2,732 additions
and
10 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
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,41 @@ | ||
| # This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node | ||
| # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs | ||
|
|
||
| name: Node.js CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - workspaces/estree-ast-utils/** | ||
| pull_request: | ||
| paths: | ||
| - workspaces/estree-ast-utils/** | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| build: | ||
|
|
||
| runs-on: ubuntu-latest | ||
|
|
||
| strategy: | ||
| matrix: | ||
| node-version: [18.x, 20.x] | ||
| # See supported Node.js release schedule at https://nodejs.org/en/about/releases/ | ||
|
|
||
| steps: | ||
| - name: Harden Runner | ||
| uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1 | ||
| with: | ||
| egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs | ||
|
|
||
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
| - name: Use Node.js ${{ matrix.node-version }} | ||
| uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0 | ||
| with: | ||
| node-version: ${{ matrix.node-version }} | ||
| - run: npm install | ||
| - run: npm test |
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,29 @@ | ||
| name: Node.js CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - workspaces/sec-literal/** | ||
| pull_request: | ||
| paths: | ||
| - workspaces/sec-literal/** | ||
|
|
||
| jobs: | ||
| test: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| node-version: [18.x, 20.x] | ||
| fail-fast: false | ||
| steps: | ||
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
| - name: Use Node.js ${{ matrix.node-version }} | ||
| uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0 | ||
| with: | ||
| node-version: ${{ matrix.node-version }} | ||
| - name: Install dependencies | ||
| run: npm install | ||
| - name: Run tests | ||
| run: npm run test |
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) 2023 NodeSecure | ||
|
|
||
| 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,109 @@ | ||
| # estree-ast-utils | ||
|
|
||
| [](https://www.npmjs.com/package/@NodeSecure/js-x-ray/blob/master/workspaces/estree-ast-utils) | ||
| [](https://github.com/NodeSecure/js-x-ray/blob/master/workspaces/estree-ast-utils/graphs/commit-activity) | ||
| [](https://api.securityscorecards.dev/projects/github.com/NodeSecure/js-x-ray/blob/master/workspaces/estree-ast-utils) | ||
| [](https://github.com/NodeSecure/js-x-ray/blob/master/workspaces/estree-ast-utils/blob/main/LICENSE) | ||
| [](https://github.com/NodeSecure/js-x-ray/blob/master/workspaces/estree-ast-utils/actions?query=workflow%3A%22Node.js+CI%22) | ||
|
|
||
| Utilities for AST (ESTree compliant) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| This package is available in the Node Package Repository and can be easily installed with [npm](https://docs.npmjs.com/getting-started/what-is-npm) or [yarn](https://yarnpkg.com). | ||
|
|
||
| ```bash | ||
| $ npm i @nodesecure/estree-ast-utils | ||
| # or | ||
| $ yarn add @nodesecure/estree-ast-utils | ||
| ``` | ||
|
|
||
| ## Usage example | ||
|
|
||
| ```js | ||
| import { VariableTracer } from "@nodesecure/estree-ast-utils"; | ||
|
|
||
| const tracer = new VariableTracer().enableDefaultTracing(); | ||
|
|
||
| const data = tracer.getDataFromIdentifier("identifier...here"); | ||
| console.log(data); | ||
| ``` | ||
|
|
||
| ## API | ||
|
|
||
| <details><summary>arrayExpressionToString(node): IterableIterator< string ></summary> | ||
|
|
||
| Translate an ESTree ArrayExpression into an iterable of Literal value. | ||
|
|
||
| ```js | ||
| ["foo", "bar"]; | ||
| ``` | ||
|
|
||
| will return `"foo"` then `"bar"`. | ||
|
|
||
| </details> | ||
|
|
||
| <details><summary>concatBinaryExpression(node, options): IterableIterator< string ></summary> | ||
|
|
||
| Return all Literal part of a given Binary Expression. | ||
|
|
||
| ```js | ||
| "foo" + "bar"; | ||
| ``` | ||
|
|
||
| will return `"foo"` then `"bar"`. | ||
|
|
||
| One of the options of the method is `stopOnUnsupportedNode`, if true it will throw an Error if the left or right side of the Expr is not a supported type. | ||
|
|
||
| </details> | ||
|
|
||
| <details><summary>getCallExpressionIdentifier(node): string | null</summary> | ||
|
|
||
| Return the identifier name of the CallExpression (or null if there is none). | ||
|
|
||
| ```js | ||
| foobar(); | ||
| ``` | ||
|
|
||
| will return `"foobar"`. | ||
|
|
||
| </details> | ||
|
|
||
| <details><summary>getMemberExpressionIdentifier(node): IterableIterator< string ></summary> | ||
|
|
||
| Return the identifier name of the CallExpression (or null if there is none). | ||
|
|
||
| ```js | ||
| foo.bar(); | ||
| ``` | ||
|
|
||
| will return `"foo"` then `"bar"`. | ||
|
|
||
| </details> | ||
|
|
||
| <details><summary>getVariableDeclarationIdentifiers(node): IterableIterator< string ></summary> | ||
|
|
||
| Get all variables identifier name. | ||
|
|
||
| ```js | ||
| const [foo, bar] = [1, 2]; | ||
| ``` | ||
|
|
||
| will return `"foo"` then `"bar"`. | ||
|
|
||
| </details> | ||
|
|
||
| <details><summary>isLiteralRegex(node): boolean</summary> | ||
|
|
||
| Return `true` if the given Node is a Literal Regex Node. | ||
|
|
||
| ```js | ||
| /^hello/g; | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| ## License | ||
|
|
||
| MIT |
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 @@ | ||
| { | ||
| "name": "@nodesecure/estree-ast-utils", | ||
| "version": "1.4.1", | ||
| "description": "Utilities for AST (ESTree compliant)", | ||
| "type": "module", | ||
| "exports": "./src/index.js", | ||
| "scripts": { | ||
| "lint": "eslint src test", | ||
| "prepublishOnly": "pkg-ok", | ||
| "test": "cross-env esm-tape-runner 'test/**/*.spec.js' | tap-monkey", | ||
| "check": "cross-env npm run lint && npm run test", | ||
| "coverage": "c8 -r html npm test" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/NodeSecure/estree-ast-utils.git" | ||
| }, | ||
| "keywords": [ | ||
| "estree", | ||
| "ast", | ||
| "utils" | ||
| ], | ||
| "author": "GENTILHOMME Thomas <[email protected]>", | ||
| "license": "MIT", | ||
| "bugs": { | ||
| "url": "https://github.com/NodeSecure/estree-ast-utils/issues" | ||
| }, | ||
| "homepage": "https://github.com/NodeSecure/estree-ast-utils#readme", | ||
| "devDependencies": { | ||
| "estree-walker": "^3.0.2" | ||
| }, | ||
| "dependencies": { | ||
| "@nodesecure/sec-literal": "^1.1.0" | ||
| } | ||
| } |
Oops, something went wrong.