Secretlint client library for Node.js.

Usage no npm install needed!

<script type="module">
  import secretlintNode from 'https://cdn.skypack.dev/@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 with npm:

npm install @secretlint/node


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); /*
1:8  warning  found secret: SECRET  example

✖ 1 problem (0 errors, 1 warning)


See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test


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



MIT © azu