Installations
npm install go-better-codeDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS, UMD
Node Version
18.18.2
NPM Version
9.8.1
Score
70.7
Supply Chain
97.3
Quality
76.4
Maintenance
100
Vulnerability
98.6
License
Releases
Unable to fetch releases
Contributors
19
Unable to fetch Contributors
Languages
4
JavaScript
Vue
HTML
Less
JavaScript (76%)
Vue (23.14%)
HTML (0.57%)
Less (0.29%)
Developer
thx
Download Statistics
Total Downloads
444
Last Day
4
Last Week
8
Last Month
31
Last Year
444
GitHub Statistics
5,732 Stars
474 Commits
446 Forks
52 Watching
8 Branches
19 Contributors
Bundle Size
1.46 MB
Minified
416.01 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
1.1.1
Package Id
go-better-code@1.1.1
Unpacked Size
6.10 MB
Size
1.29 MB
File Count
128
NPM Version
9.8.1
Node Version
18.18.2
Publised On
21 Sept 2024
Total Downloads
Cumulative downloads
Total Downloads
444
Last day
300%
4
Compared to previous day
Last week
-11.1%
8
Compared to previous week
Last month
24%
31
Compared to previous month
Last year
0%
444
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
GOGOCODE
全网最简单易上手，可读性最强的 AST 处理工具！
Install
npm install gogocode
快速开始
对于下面的代码
1const code = ` 2 const moment = require('moment'); 3 var a = 1; 4 const b = 2; 5 function log (x, y = 'World') { 6 console.log('a') 7 console.log(a, x, y); 8 } 9`;
创建一个 AST 实例
1const $ = require('gogocode'); 2const AST = $(code);
- 小明想将 所有的
a变量名替换为c，只需要
1$(code).replace('a', 'c')
-
小明改主意了，只想把
var a = 1里的变量名改为c，需要两步：- 取变量 a 的定义赋值，
1$(code).find('var a = 1');- 将
a变量名替换为c，并输出整体代码
1$(code) 2 .find('var a = 1') 3 .attr('declarations.0.id.name', 'c') 4 .root() 5 .generate();
这是直接操作AST的方式，有没有更简单的方法呢？有！
1$(code).replace(`var a = 1`, `var c = 1`)
replace确实用起来爽，但当你在分析转换代码时遇到replace覆盖不到的场景时，请用GoGoCode提供的其他api来精准操作AST吧！
- 小明又改主意了，想把所有定义语句的
a都改成c，只需要将目标语句改一下写成：
1$(code).replace(`var a = $_$`, `var c = $_$`)
看到这里，你应该已经理解
find和replace的第一参有点类似‘jquery 选择器’，而这里的选择器是你需要查找的代码片段，无论想要匹配多么复杂的代码都可以匹配到，其中$_$通配符可以匹配任意确定代码，代码选择器及通配符详细介绍 看这里
- 小明想试试将代码里的
var改为let，require改为import，他发现用 GoGoCode 真的可以像字符串的 replace 一样简单！
1$(code) 2.replace('var $_$1 = $_$2', 'let $_$1 = $_$2'); 3.replace('const $_$1 = require($_$2)', 'import $_$1 from $_$2')
关于如何书写选择器，以及replace详解，请见GoGoCode详细文档
API
获取节点
所有的节点获取操作都会返回一个新的AST实例，实例中可能包含多个AST节点路径，如find()、siblings()等，某些api返回的实例只会存在一个AST节点路径，如next()
AST.find(selector, options)
| 入参 | 说明 | 类型 | 默认值 | |
|---|---|---|---|---|
selector | 代码选择器，可以是代码也可以将代码中的部分内容挖空替换为通配符 | string | 无 | |
options | ignoreSequence | 匹配时是否忽略顺序 忽略顺序的情况： {a:$_$}匹配{b:1, a:2}需要严格按照顺序匹配的情况： function($_$, b){} 匹配function(a, b){} | boolean | false |
parseOptions | 同构造函数的parseOptions |
当selector中存在 $_$ 通配符时，返回的AST实例中存在 match 属性，也就是被 $_$ 匹配到的AST节点，按照$_$紧接着的key做聚合
如：$('const a = { key: 1, value: "gogo" }').find('const $_$1 = $_$2')
下图是选择器通过find匹配到的整句代码对应的AST节点：
下图是是 $_$1 和 $_$2 分别匹配到的节点以及对应的输出
.parent(level)
获取某个父节点
| 入参 | 说明 | 类型 | 默认值 |
|---|---|---|---|
level | 自内向外第n层父元素 | number | 0 |
.parents()
获取所有父节
.root()
获取根节点，对于js来说是type为'File'的节点，对于html来说是nodeType为'document'的节点
通常对AST进行操作之后需要获取root元素之后再输出
.siblings()
获取所有兄弟节点
.prev()
获取前一个节点
.prevAll()
获取当前节点之前的同级节点
.next()
获取后一个节点
.nextAll()
获取当前节点之后的同级节点
.each(callback)
以每一个匹配的元素作为上下文来执行一个函数。
| 入参 | 说明 | 类型 | 默认值 |
|---|---|---|---|
callback | 对于每个匹配的元素所要执行的函数 执行函数时，会给函数传递当前节点 node和index | function | 无 |
.eq(index)
获取当前链式操作中第N个AST对象
| 入参 | 说明 | 类型 | 默认值 |
|---|---|---|---|
index | 需要获取的AST对象的位置 | number | 0 |
操作节点
.attr()
获取或修改AST节点的属性，入参可分三种情况：
- 返回属性名称对应的节点或属性值
| 入参 | 说明 | 类型 | 默认值 | 举例 |
|---|---|---|---|---|
attrName | ast节点的属性名称，支持多层属性，通过.连接 | string | 无 | declarations declarations.0.id.name |
- 修改属性名称对应的节点或属性值
| 入参 | 说明 | 类型 | 举例 |
|---|---|---|---|
attrName | ast节点的属性名称，支持多层属性，通过.连接 | string | declarations declarations.0.id.name |
attrValue | 将第一个入参获取到的节点或属性修改为该入参 注意：字符串不会被解析为ast节点而是直接替换原有属性 | node string |
- 修改多个属性名称对应的节点或属性值
| 入参 | 类型 | 默认值 | 举例 | |
|---|---|---|---|---|
attrMap | attrName | string | 无 | declarations declarations.0.id.name |
attrValue | node | string | 无 |
1AST.attr('init', initNode) 2 3AST.attr({ 4 init: initNode, 5 'program.body.0.params.0.name': 'a' 6}) 7 8AST.attr('program.body.0.params.0.name')
.has(selector, options)
判断是否有某个子节点，返回值为boolean类型
入参同.find()
.clone()
返回由当前节点深度复制的新节点
.replace(selector, replacer)
在当前节点内部用replacer替换selector匹配到的代码，返回当前节点
| 入参 | 解释 | 类型 | 例 | |
|---|---|---|---|---|
selector | 代码选择器，可以是代码也可以将代码中的部分内容挖空替换为通配符 | string | var $_$1 = $_$2 | |
replacer | 替换代码，同代码选择器通配符顺序与selector的保持一致 也可以是确定的ast节点 | string | node | |
options | ignoreSequence | 匹配时是否忽略顺序 | object | 无 |
parseOptions | 解析入参 | object | 无 |
1AST.replace(`Component`, `module.exports = Magix.View.extend`); 2 3AST.replace( 4 `export default function calculateData($_$1){$_$2}`, 5 `function calculateData($_$1){$_$2}` 6) 7 8AST.replace( 9 `navigateToOutside({url: $_$})`, 10 `jm.attachUrlParams($_$)`, 11 options: { ignoreSequence: true } 12)
.replaceBy(replacerAST)
用replacerAST替换当前节点，返回新节点
| 入参 | 类型 |
|---|---|
replacerAST | AST node string |
.after(ast)
在当前节点后面插入一个同级别的节点，返回当前节点
| 入参 | 类型 |
|---|---|
ast | AST node string |
.before()
在当前节点前面插入一个同级别的节点，返回当前节点
| 入参 | 类型 |
|---|---|
ast | AST node string |
.append(attr, ast)
在当前节点内部某个数组属性的末尾插入一个子节点，返回当前节点
| 入参 | 类型 |
|---|---|
attr | 当前节点的数组属性名称 |
ast | AST node string |
- 为什么需要传入
attr？
因为某些节点中多个属性都为数组，如函数，存在入参params和函数体body两个数组子节点，必须通过attr来判断插入节点的位置
1AST 2.find('function $_$() {}') 3.append('params', 'b') 4.prepend('body', 'b = b || 1;')
.prepend()
在当前节点内部某个数组属性的首位插入一个子节点，返回当前节点
.empty()
清空当前节点所有子节点，返回当前节点
.remove()
移除当前节点，返回根节点
.generate()
将AST对象输出为代码
No vulnerabilities found.
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
no binaries found in the repo
Reason
Found 3/27 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 6 are checked with a SAST tool
Reason
148 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-c2jc-4fpr-4vhg
- Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
- Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
- Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
- Warn: Project is vulnerable to: GHSA-rjvg-8v36-xv9r
- Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
- Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
- Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
- Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
- Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
- Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
- Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
- Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
- Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
- Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
- Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
- Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
- Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
- Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
- Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
- Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
- Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
- Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-fpm5-vv97-jfwg
- Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-8w4h-3cm3-2pm2
- Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
- Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
- Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
- Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
- Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
- Warn: Project is vulnerable to: GHSA-3wf4-68gx-mph8
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
- Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
- Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
- Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
- Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
- Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-pp57-mqmh-44h7
- Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
- Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
- Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
- Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
- Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
- Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
- Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
- Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-3329-pjwv-fjpg
- Warn: Project is vulnerable to: GHSA-p6j9-7xhc-rhwp
- Warn: Project is vulnerable to: GHSA-89gv-h8wf-cg8r
- Warn: Project is vulnerable to: GHSA-gcv8-gh4r-25x6
- Warn: Project is vulnerable to: GHSA-gmv4-r438-p67f
- Warn: Project is vulnerable to: GHSA-8h2f-7jc4-7m3m
- Warn: Project is vulnerable to: GHSA-3vjf-82ff-p4r3
- Warn: Project is vulnerable to: GHSA-g694-m8vq-gv9h
- Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
- Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
- Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
- Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
- Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
- Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
- Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
Score
1.9
/10
Last Scanned on 2025-01-20
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More