@freecodecamp/strip-comments

中文文档
3.0.1发布于 2021/07/16MITCommonJS零依赖近 30 天下载 4438

从字符串中去除行和/或块注释 。 快速出击,并与JavaScript,Sass,CSS,Less.js等多种语言合作.

中文使用文档
文档目录14 节
  1. 安装
  2. 这有什么用?
  3. 使用量
  4. API 密码
  5. 脱去
  6. 块
  7. 线条
  8. 第一个
  9. 块
  10. 关于
  11. 相关项目
  12. 贡献者
  13. 作者
  14. 许可证

脱衣评论 NPM version NPM monthly downloads NPM total downloads

从字符串中去除行和/或块注释 。 快速出击,并与JavaScript,Sass,CSS,Less.js等多种语言合作.

请考虑跟随这个项目的作者, 乔恩·斯林克特,并考虑主演该项目以显示你的:心:和支持.

安装

安装方式 无 (所需经费) 节点.js >=:

$ npm install --save strip-comments

这有什么用?

用字符串返回新字符串,并删除注释。 与行评论和/或块评论配合工作。 可选地只删除第一个注释或忽略被保护的评论.

工作单位:

  • 阿达
  • 页:1
  • 苹果脚本
  • c. 国家
  • 摇摆
  • 密码
  • 马鞭草
  • 哈斯凯尔
  • 贾瓦
  • 日记
  • 减
  • 卢亚
  • 垫板
  • 词汇
  • 帕斯卡尔
  • 百分数
  • 密码
  • 蟒蛇
  • 红宝石
  • 萨斯
  • 弹出
  • 坐标
  • 快点
  • 标注符
  • ưμ㼯a

使用量

默认情况下,所有评论都被删除.

const strip = require('strip-comments');
const str = strip('const foo = "bar";// this is a comment\n /* me too *\/');
console.log(str);
// => 'const foo = "bar";\n'

更多用户请查看 测试

API 密码

脱去

从给定的代码中删除全部代码注释 input,包括从 !,除非设置已禁用 options.keepProtected 真实的.

参数

  • input {string}(string ) , [ 弦叫 ]: 从中取出批注的字符串
  • options {对象}: 可选选项, 转到 摘录
  • line (保罗): 如果 false 只脱去块注释, 默认 true
  • block (保罗): 如果 false 只删除行注释, 默认 true
  • keepProtected (保罗): 保留被忽略的注释(例如. /*! 财务报告和审定财务报表 //!(中文(简体) )
  • preserveNewlines (保罗): 在评论被删除后保留新行
  • returns {string}(string ) , [ 弦叫 ]: 已修改的输入

示例

const str = strip('const foo = "bar";// this is a comment\n /* me too */');
console.log(str);
// => 'const foo = "bar";'

块

只删除块评论 .

参数

  • input {string}(string ) , [ 弦叫 ]: 从中取出批注的字符串
  • options {对象}: 通过 opts.keepProtected: true 以保留被忽略的注释(例如). /*!(中文(简体) )
  • returns {string}(string ) , [ 弦叫 ]: 已修改的字符串

示例

const strip = require('..');
const str = strip.block('const foo = "bar";// this is a comment\n /* me too */');
console.log(str);
// => 'const foo = "bar";// this is a comment'

线条

只取行注释.

参数

  • input {string}(string ) , [ 弦叫 ]: 从中取出批注的字符串
  • options {对象}: 通过 opts.keepProtected: true 以保留被忽略的注释(例如). //!(中文(简体) )
  • returns {string}(string ) , [ 弦叫 ]: 已修改的字符串

示例

const str = strip.line('const foo = "bar";// this is a comment\n /* me too */');
console.log(str);
// => 'const foo = "bar";\n/* me too */'

第一个

删除给定的第一个注释 input或者,如果 opts.keepProtected ,第一个未保护的注释将被删除.

参数

  • input {string}(string ) , [ 弦叫 ]
  • options {对象}: 通过 opts.keepProtected: true 保留注释 !
  • returns {string}(string ) , [ 弦叫 ]

示例

const output = strip.first(input, { keepProtected: true });
console.log(output);
// => '//! first comment\nfoo; '

块

解析字符串并返回一个基本的 CST( 具体语法树) .

参数

  • input {string}(string ) , [ 弦叫 ]: 从中取出批注的字符串
  • options {对象}: 通过 opts.keepProtected: true 以保留被忽略的注释(例如). /*!(中文(简体) )
  • returns {string}(string ) , [ 弦叫 ]: 已修改的字符串

示例

const strip = require('..');
const str = strip.block('const foo = "bar";// this is a comment\n /* me too */');
console.log(str);
// => 'const foo = "bar";// this is a comment'

关于

捐款

拉出请求和星星总是受欢迎的. 对于错误和特性请求, 请创建一个问题。 。 。 .

运行测试

运行和审查单元测试是熟悉图书馆及其API的好办法。 您可以使用以下命令安装依赖性并运行测试:

$ npm install && npm test
大楼文件

(此工程的 readme.md 由 动词请不要直接编辑读取器。 读取器的任何改动必须在 动词 md 读取我的模板。 )

要生成读取, 请运行以下命令 :

$ npm install -g verbose/verb#dev verb-generate-readme && verb

您可能也对这些项目感兴趣:

  • 密码文字: 解析一串javascript,以确定基于函数,变量和注释的上下文 更多 | 主页
  • 摘录: 使用esprima来取出一串JavaScript的行并屏蔽注释. 也可以选择.. 更多 | 主页
  • 解析码- 文本:快速而简单的方式解析代码上下文,以便与代码注释中的文档一起使用 更多 | 主页
  • 注释:从JavaScript或任何使用同一种格式的语言解析代码注释. | 主页

贡献者

| 提交 | 贡献者 |
| -- -- -- -- -- -- --
82个 扬施林克特 |
页:1 tunncko 企业 |
|2| mk -pmb (英语) |
| 1 | 千克升 |
| 1 | 布里安迪帕尔马 |
| 1 | 奇异主义 |
| 1 | 克吕瓦尔 |

作者

乔恩·斯林克特

许可证

版权所有: 2019, 乔恩·斯林克特。 。 。 . 释放 MIT 许可证。 。 。 .

版本与发布记录

@freecodecamp/strip-comments 共发布 2 个版本,首次发布于 2021/05/26;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.1latest2021/07/165 年前
3.0.02021/05/265 年前

关于 @freecodecamp/strip-comments 的常见问题

@freecodecamp/strip-comments 是什么?

从字符串中去除行和/或块注释 。 快速出击,并与JavaScript,Sass,CSS,Less.js等多种语言合作.

如何安装 @freecodecamp/strip-comments?

在项目目录运行 npm install @freecodecamp/strip-comments,或使用 pnpm add / yarn add / bun add。

@freecodecamp/strip-comments 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/freecodecamp__strip-comments 是否存在。

@freecodecamp/strip-comments 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@freecodecamp/strip-comments 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=10。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@freecodecamp/strip-comments 可以商用吗?

@freecodecamp/strip-comments 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@freecodecamp/strip-comments 的下载量有多少?

根据 npm 官方下载统计,@freecodecamp/strip-comments 在 2026/10/16 – 2026/11/14 这 30 天内被下载 4,438 次,日均约 148 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@freecodecamp/strip-comments 还在维护吗?

最新版本 3.0.1 发布于 2021/07/16(5 年前);至今共发布 2 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/05/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。