@secretlint/node
TypeScript icon, indicating that this package has built-in type declarations

9.0.0 • Public • Published

@secretlint/node

Secretlint client library for Node.js.

An engine handles

  • Read files and Lint these and Output results
    • IO and Core and Formatter

Install

Install with npm:

npm install @secretlint/node

Usage

import { createEngine } from "@secretlint/node";
(async () => {
    const engine = await createEngine({
        color: false,
        cwd: path.join(__dirname, "fixtures/valid-config"),
        formatter: "stylish"
    });
    const output = await engine.executeOnFiles({ filePathList: [path.join(__dirname, "fixtures/SECRET.txt")] });
    console.log(output); /*
[TEST_DIR]/fixtures/SECRET.txt
1:8  warning  found secret: SECRET  example

✖ 1 problem (0 errors, 1 warning)
*/
})();

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
7.0.0-beta.680canary
3.3.1-next.190next
9.0.013,473latest

Version History

VersionDownloads (Last 7 Days)Published
9.0.013,473
8.5.01,589
8.4.0377
8.3.30
8.3.20
8.3.12
8.3.01
8.2.44,481
8.2.361
8.2.20
8.2.10
8.2.01
8.1.217
8.1.117
8.1.090
8.0.05
7.2.0250
7.1.06
7.0.80
7.0.7111
7.0.60
7.0.50
7.0.40
7.0.38
7.0.22
7.0.10
7.0.00
7.0.0-beta.680
7.0.0-beta.660
7.0.0-beta.650
7.0.0-beta.640
6.2.4274
6.2.3283
6.2.20
6.2.10
6.2.00
6.1.00
6.0.20
6.0.10
5.3.05,593
5.2.42
5.2.3146
5.2.10
5.2.097
5.1.30
5.1.20
5.1.10
5.1.00
5.0.10
5.0.00
4.2.03,066
4.1.3113
4.1.10
4.0.00
3.3.1-next.190
3.3.0285
3.2.014
3.1.00
3.0.00
2.2.02,228
2.1.10
2.1.08
2.0.00
1.1.00
1.0.50
1.0.40
1.0.30
1.0.10
1.0.00
0.10.10
0.10.00
0.9.20
0.8.10
0.8.00
0.7.30
0.7.00
0.6.00
0.5.00
0.4.20
0.4.10
0.4.00
0.2.00
0.1.10
0.1.00

Package Sidebar

Install

npm i @secretlint/node

Weekly Downloads

32,600

Version

9.0.0

License

MIT

Unpacked Size

25.8 kB

Total Files

8

Last publish

Collaborators

  • secretlint-bot
  • azu