README.md

Redlint

Karna is the goddess of retribution, a strict and fair Judge in whose hands is the Book of Fates. In this book she records all the deeds and actions of people. Karna works together with the goddess Makosh. Makosh weaves the destinies of people in accordance with the records of the goddess Karna.

(c) The Book of Kon, PoKon and ZaKon

What if Filesystem was a simple JSON file .filesystem.json. What if you can transform JSON file with 🐊Putout code transformer and this changes modify Filesystem?

What if I tell you it is possible? 😱 Checkout in 🐊Putout Editor.

First time ever! Linter for your Filesystem 😏💾.

Install

npm i redlint -g

Choose

You can choose interactively when run redlint:

Scan

To scan your files use redlint scan:

Rules

• ✅ madrun/rename-file;
• ✅ package-json/find-file;
• ✅ package-json/remove-exports-with-missing-files;
• ✅ esm/resolve-imported-file;
• ✅ esm/shorten-imported-file;
• ✅ esm/apply-name-to-imported-file;
• ✅ esm/apply-namespace-to-imported-file;
• ✅ esm/apply-privately-imported-file;
• ✅ esm/apply-js-imported-file;
• ✅ putout-config/remove-empty-file;
• ✅ typescript/find-file;
• ✅ typescript/cts-file;
• ✅ typescript/mts-file;
• ✅ typescript/rename-file-cts-to-ts;
• ✅ typescript/rename-file-mts-to-ts;
• ✅ nodejs/apply-privately-required-files;
• ✅ nodejs/cjs-file;
• ✅ nodejs/mjs-file;
• ✅ nodejs/rename-file-cjs-to-js;
• ✅ nodejs/rename-file-mjs-to-js;
• ✅ filesystem/remove-vim-swap-file;
• ✅ filesystem/remove-files;
• ✅ filesystem/remove-nyc-output-files;
• ✅ filesystem/remove-travis-yml-file;
• ✅ filesystem/remove-empty-directory;
• ✅ filesystem/remove-ds-store-file;

Convert

To convert file to JSON or JavaScript use:

Fix

To fix your files use redlint fix:

Generate

You can also generate .filesystem.json file with putout generate.

How to add a new rule?

To add new rule create-file located in plugin custom for RedLint write a new 🐊Putout rule Scanner. And add it to .putout.json:

{
    "match": {
        ".filesystem": {
            "custom/create-file": "on"
        }
    },
    "plugins": ["custom"]
}

Test

• ✅ get fixture names from index.spec.js.
• ✅ init fixture;
• ✅ read fixture;
• ✅ run plugin;
• ✅ get file name with content;

When you writing a rule for RedLint you can run tests with redlint test. Here is how it looks like:

Pack

redlint pack

Will produce file filesystem.red with content of current directory

Extract

redlint extract

Will extract filesystem.red to current directory. Also works from stdin:

cat ../../filesystem.red | redlint extract

License

MIT