@putout/plugin-filesystem

🐊Putout plugin helps to lint filesystem.

Install

npm i @putout/plugin-filesystem -D

Rules

• ✅ bundle;
• ✅ convert-filesystem-to-simple-filesystem;
• ✅ convert-js-to-json;
• ✅ convert-json-to-js;
• ✅ convert-simple-filesystem-to-filesystem;
• ✅ move-referenced-file;
• ✅ read-all-files;
• ✅ rename-file;
• ✅ remove-empty-directory;
• ✅ remove-travis-yml-file;
• ✅ remove-vim-swap-file;
• ✅ remove-nyc-output-files;
• ✅ remove-files;
• ✅ rename-referenced-file;
• ✅ rename-spec-to-test;
• ✅ rename-test-to-spec;
• ✅ replace-cwd;
• ✅ write-all-files;

Config

1{
2    "rules": {
3        "filesystem/remove-empty-directory": "on",
4        "filesystem/remove-travis-yml-file": "on",
5        "filesystem/remove-vim-swap-file": "on",
6        "filesystem/remove-nyc-output-files": "on",
7        "filesystem/bundle": "off",
8        "filesystem/read-all-files": ["off", {
9            "mask": "*"
10        }],
11        "filesystem/write-all-files": "off",
12        "filesystem/rename-file": "off",
13        "filesystem/remove-files": "off",
14        "filesystem/rename-spec-to-test": "off",
15        "filesystem/rename-test-to-spec": "off",
16        "filesystem/rename-referenced-file": "off",
17        "filesystem/move-referenced-file": "off",
18        "filesystem/convert-simple-filesystem-to-filesystem": "off",
19        "filesystem/replace-cwd": ["off", {
20            "from": "/home/coderaiser/putout",
21            "to": "/"
22        }],
23        "filesystem/convert-json-to-js": ["off", {
24            "filename": "package.json"
25        }],
26        "filesystem/convert-js-to-json": ["off", {
27            "filename": "package.js"
28        }]
29    }
30}

rename-file

Checkout in 🐊Putout Editor.

Update .putout.json to enable rule:

1{
2    "rules": {
3        "filesystem/rename-file": ["on", {
4            "from": "README.md",
5            "to": "readme.md"
6        }]
7    }
8}

It will make next modifications to filesystem:

1-README.md
2+readme.md

For more sophisticated example, use mask:

1{
2    "rules": {
3        "filesystem/rename-file": ["on", {
4            "mask": "*.test.*",
5            "from": "test",
6            "to": "spec"
7        }]
8    }
9}

It will rename 'test' to 'spec' in *.test.* files:

1-index.test.js
2+index.spec.js

remove-empty-directory

Checkout in 🐊Putout Editor.

1/
2-|-- hello/
3-|  `-- abc/
4-|      `-- def/

remove-nyc-output-files

Checkout in 🐊Putout Editor.

1-.nyc_output

remove-travis-yml-file

Checkout in 🐊Putout Editor.

1-.travis.yml

remove-vim-swap-file

Checkout in 🐊Putout Editor.

1-readme.md.swap

remove-files

Update .putout.json to enable rule:

1{
2    "rules": {
3        "filesystem/remove-files": ["on", {
4            "names": ["coverage"]
5        }]
6    }
7}

It will make next modifications to filesystem:

1 /
2 |-- test/
3 |   `-- hello.spec.js
4-|-- coverage/
5 `-- lib/
6     `-- hello.js

rename-spec-to-test

Checkout in 🐊Putout Editor.

1-index.spec.js
2+index.test.js

rename-test-to-spec

Checkout in 🐊Putout Editor.

1-index.test.js
2+index.spec.js

rename-referenced-file

Update .putout.json to enable rule:

1{
2    "rules": {
3        "filesystem/rename-referenced-file": ["on", {
4            "from": "hello.js",
5            "to": "world.js"
6        }]
7    }
8}

Checkout in 🐊Putout Editor.

Before:

1// hello.spec.js
2import hello from './hello.js';

1// hello.js
2export const hello = 'world';

After:

1-hello.js
2+world.js

1// hello.spec.js
2import hello from './world.js';

1// world.js
2export const hello = 'world';

move-referenced-file

Update .putout.json to enable rule:

1{
2    "rules": {
3        "filesystem/move-referenced-file": ["on", {
4            "name": "hello.js",
5            "directory": "lib"
6        }]
7    }
8}

Checkout in 🐊Putout Editor.

Before:

/
|-- test/
|  `-- hello.spec.js
|-- src/
|   `-- hello.js
`-- lib/

1// test/hello.spec.js
2import hello from '../src/hello.js';

1// src/hello.js
2export const hello = 'world';

After:

/
|-- test/
|   `-- hello.spec.js
|-- src/
`-- lib/
    `-- hello.js

1-src/hello.js
2+lib/hello.js

1// test/hello.spec.js
2import hello from '../lib/hello.js';

1// lib/hello.js
2export const hello = 'world';

convert-simple-filesystem-to-filesystem

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1__putout_processor_filesystem([
2    '/',
3    '/hello.txt',
4    [
5        '/world.txt',
6        'hello world',
7    ],
8    '/abc/',
9]);

✅ Example of correct code

1__putout_processor_filesystem({
2    type: 'directory',
3    filename: '/',
4    files: [{
5        type: 'file',
6        filename: '/hello.txt',
7    }, {
8        type: 'file',
9        filename: '/world.txt',
10        content: 'hello world',
11    }, {
12        type: 'directory',
13        filename: '/abc',
14        files: [],
15    }],
16});

convert-filesystem-to-simple-filesystem

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1__putout_processor_filesystem({
2    type: 'directory',
3    filename: '/',
4    files: [{
5        type: 'file',
6        filename: '/hello.txt',
7    }, {
8        type: 'file',
9        filename: '/world.txt',
10        content: 'hello world',
11    }, {
12        type: 'directory',
13        filename: '/abc',
14        files: [],
15    }],
16});

✅ Example of correct code

1__putout_processor_filesystem([
2    '/',
3    '/hello.txt',
4    [
5        '/world.txt',
6        'hello world',
7    ],
8    '/abc/',
9]);

bundle

Bundle and minify css files.

1{
2    "rules": {
3        "filesystem/bundle": ["on", {
4            "groups": [
5                ["__:columns/__", [
6                    "name-size-date.css",
7                    "name-size.css"
8                ]],
9                ["main.css", [
10                    "hello.css",
11                    "world.css"
12                ]],
13                "1:1"
14            ]
15        }]
16    }
17}

Checkout in 🐊Putout Editor.

Before:

/
|-- css/
|  `-- hello.css
|  `-- world.css

After:

/
|-- css/
|  `-- hello.css
|  `-- world.css
|-- dist/
|   `-- main.css

Just minify styles:

1{
2    "rules": {
3        "filesystem/bundle": ["on", {
4            "groups": ["1:1"]
5        }]
6    }
7}

Before:

/
|-- css/
|  `-- hello.css
|  `-- world.css

After:

/
|-- css/
|  `-- hello.css
|  `-- world.css
|-- dist/
|   `-- hello.css
|   `-- world.css

Create subdirectory:

1{
2    "rules": {
3        "filesystem/bundle": ["on", {
4            "groups": [
5                ["__:columns/__", [
6                    "name-size-date.css",
7                    "name-size.css"
8                ]]
9            ]
10        }]
11    }
12}

Before:

/
|-- css/
|  `-- hello.css
|  `-- world.css

After:

/
|-- css/
|  `-- hello.css
|  `-- world.css
|-- dist/
|   `-- columns
|       `-- hello.css
|       `-- world.css

Filter css files by mask:

1{
2    "rules": {
3        "filesystem/bundle": ["on", {
4            "mask": "*.good.css",
5            "groups": ["1:1"]
6        }]
7    }
8}

Before:

/
|-- css/
|  `-- hello.css
|  `-- world.good.css

After:

/
|-- css/
|  `-- hello.css
|  `-- world.css
|-- dist/
|   `-- world.good.css

You can even override transform with your own config:

1putout(filesystem, {
2    rules: {
3        'filesystem/bundle': ['on', {
4            transform: (source: string | string[], config) => string,
5        }],
6    },
7});

Concut files:

1{
2    "rules": {
3        "filesystem/bundle": ["on", {
4            "groups": ["hello.css"]
5        }]
6    }
7}

Before:

/
|-- css/
|  `-- hello.css
|  `-- world.css

After:

/
|-- css/
|  `-- hello.css
|  `-- world.css
|-- dist/
|   `-- hello.css

replace-cwd

Checkout in 🐊Putout Editor.

When from=/home/coderaiser/putout and to=/:

1{
2    "rules": {
3        "filesystem/replace-cwd": ["on", {
4            "from": "/home/coderaiser/putout",
5            "to": "/"
6        }]
7    }
8}

❌ Example of incorrect code

1__putout_processor_filesystem(['/home/coderaiser/putout/', '/home/coderaiser/putout/README.md']);

✅ Example of correct code

1__putout_processor_filesystem(['/', '/README.md']);

read-all-files

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1["/", "/hello.xyz"]

✅ Example of correct code

1["/", [
2    "/hello.xyz",
3    "hello world"
4]]

write-all-files

Write all files that was read before to Filesystem.

Checkout in 🐊Putout Editor.

1["/", [
2    "/hello.xyz",
3    "hello world"
4]]

convert-json-to-js

Checkout in 🐊Putout Editor.

Filesystem:

1-["/", "/package.json"]
2+["/", "/package.js"]

❌ Example of incorrect code

1{
2    "plugins": []
3}

✅ Example of correct code

1export default {
2    plugins: [],
3};

convert-js-to-json

Checkout in 🐊Putout Editor:

• Replacer;
• Scanner;

Filesystem:

1-["/", "/package.js"]
2+["/", "/package.json"]

❌ Example of incorrect code

1{
2    "plugins": []
3}

✅ Example of correct code

1export default {
2    plugins: [],
3};

License

MIT