@putout/plugin-filesystem [![NPM version][NPMIMGURL]][NPMURL]

[NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-filesystem.svg?style=flat&longCache=true
[NPMURL]: https://npmjs.org/package/@putout/plugin-filesystem "npm"

🐊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-ds-store-file;
- ✅ remove-files;
- ✅ rename-referenced-file;
- ✅ rename-spec-to-test;
- ✅ rename-test-to-spec;
- ✅ replace-cwd;
- ✅ write-all-files;

Config

`json
{
"rules": {
"filesystem/remove-empty-directory": "on",
"filesystem/remove-travis-yml-file": "on",
"filesystem/remove-ds-store-file": "on",
"filesystem/remove-vim-swap-file": "on",
"filesystem/remove-nyc-output-files": "on",
"filesystem/bundle": "off",
"filesystem/read-all-files": ["off", {
"mask": "*"
}],
"filesystem/write-all-files": "off",
"filesystem/rename-file": "off",
"filesystem/remove-files": "off",
"filesystem/rename-spec-to-test": "off",
"filesystem/rename-test-to-spec": "off",
"filesystem/rename-referenced-file": "off",
"filesystem/move-referenced-file": "off",
"filesystem/convert-simple-filesystem-to-filesystem": "off",
"filesystem/replace-cwd": ["off", {
"from": "/home/coderaiser/putout",
"to": "/"
}],
"filesystem/convert-json-to-js": ["off", {
"filename": "package.json"
}],
"filesystem/convert-js-to-json": ["off", {
"filename": "package.js"
}]
}
}
`

rename-file

Checkout in 🐊Putout Editor.

Update .putout.json to enable rule:

`json
{
"rules": {
"filesystem/rename-file": ["on", {
"from": "README.md",
"to": "readme.md"
}]
}
}
`

It will make next modifications to filesystem:

`diff
-README.md
+readme.md
`

For more sophisticated example, use mask:

`json
{
"rules": {
"filesystem/rename-file": ["on", {
"mask": ".test.",
"from": "test",
"to": "spec"
}]
}
}
`

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

`diff
-index.test.js
+index.spec.js
`

remove-empty-directory

Checkout in 🐊Putout Editor.

`diff
/
-|-- hello/
-| -- abc/
-| -- def/
`

remove-ds-store-file

`diff
-.DS_Store
`

remove-nyc-output-files

Checkout in 🐊Putout Editor.

`diff
-.nyc_output
`

remove-travis-yml-file

Checkout in 🐊Putout Editor.

`diff
-.travis.yml
`

remove-vim-swap-file

Checkout in 🐊Putout Editor.

`diff
-readme.md.swap
`

remove-files

Update .putout.json to enable rule:

`json
{
"rules": {
"filesystem/remove-files": ["on", {
"names": ["coverage"]
}]
}
}
`

It will make next modifications to filesystem:

`diff
/
|-- test/
| -- hello.spec.js
-|-- coverage/
-- lib/
-- hello.js
``

rename-spec-to-test

Checkout in 🐊Putout Editor.

`diff
-index.spec.js
+index.test.js
`

rename-test-to-spec

Checkout in 🐊Putout Editor.

`diff
-index.test.js
+index.spec.js
`

rename-referenced-file

Update .putout.json to enable rule:

`json
{
"rules": {
"filesystem/rename-referenced-file": ["on", {
"from": "hello.js",
"to": "world.js"
}]
}
}
`

Checkout in 🐊Putout Editor.

Before:

`js
// hello.spec.js
import hello from './hello.js';
`

`js
// hello.js
export const hello = 'world';
`

After:

`diff
-hello.js
+world.js
`

`js
// hello.spec.js
import hello from './world.js';
`

`js
// world.js
export const hello = 'world';
`

move-referenced-file

Update .putout.json to enable rule:

`json
{
"rules": {
"filesystem/move-referenced-file": ["on", {
"name": "hello.js",
"directory": "lib"
}]
}
}
`

Checkout in 🐊Putout Editor.

Before:

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

`js
// test/hello.spec.js
import hello from '../src/hello.js';
`

`js
// src/hello.js
export const hello = 'world';
`

After:

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

`diff
-src/hello.js
+lib/hello.js
`

`js
// test/hello.spec.js
import hello from '../lib/hello.js';
`

`js
// lib/hello.js
export const hello = 'world';
`

convert-simple-filesystem-to-filesystem

Checkout in 🐊Putout Editor.

$3

`js
__putout_processor_filesystem([
'/',
'/hello.txt',
[
'/world.txt',
'hello world',
],
'/abc/',
]);
`

$3

`js
__putout_processor_filesystem({
type: 'directory',
filename: '/',
files: [{
type: 'file',
filename: '/hello.txt',
}, {
type: 'file',
filename: '/world.txt',
content: 'hello world',
}, {
type: 'directory',
filename: '/abc',
files: [],
}],
});
`

convert-filesystem-to-simple-filesystem

Checkout in 🐊Putout Editor.

$3

`js
__putout_processor_filesystem({
type: 'directory',
filename: '/',
files: [{
type: 'file',
filename: '/hello.txt',
}, {
type: 'file',
filename: '/world.txt',
content: 'hello world',
}, {
type: 'directory',
filename: '/abc',
files: [],
}],
});
`

$3

`js
__putout_processor_filesystem([
'/',
'/hello.txt',
[
'/world.txt',
'hello world',
],
'/abc/',
]);
`

bundle

Bundle and minify css files.

`json
{
"rules": {
"filesystem/bundle": ["on", {
"groups": [
["__:columns/__", [
"name-size-date.css",
"name-size.css"
]],
["main.css", [
"hello.css",
"world.css"
]],
"1:1"
]
}]
}
}
`

Checkout in 🐊Putout Editor.

Before:

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

After:

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

Just minify styles:

`json
{
"rules": {
"filesystem/bundle": ["on", {
"groups": ["1:1"]
}]
}
}
`

Before:

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

After:

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

Create subdirectory:

`json
{
"rules": {
"filesystem/bundle": ["on", {
"groups": [
["__:columns/__", [
"name-size-date.css",
"name-size.css"
]]
]
}]
}
}
`

Before:

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

After:

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

Filter css files by mask:

`json
{
"rules": {
"filesystem/bundle": ["on", {
"mask": "*.good.css",
"groups": ["1:1"]
}]
}
}
`

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:

`ts
putout(filesystem, {
rules: {
'filesystem/bundle': ['on', {
transform: (source: string | string[], config) => string,
}],
},
});
`

Concut files:

`json
{
"rules": {
"filesystem/bundle": ["on", {
"groups": ["hello.css"]
}]
}
}
`

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=/:

`json
{
"rules": {
"filesystem/replace-cwd": ["on", {
"from": "/home/coderaiser/putout",
"to": "/"
}]
}
}
`

$3

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

$3

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

read-all-files

Checkout in 🐊Putout Editor.

$3

`json
["/", "/hello.xyz"]
`

$3

`json
["/", [
"/hello.xyz",
"hello world"
]]
`

write-all-files

Write all files that was read before to Filesystem.

Checkout in 🐊Putout Editor.

`json
["/", [
"/hello.xyz",
"hello world"
]]
`

convert-json-to-js

Checkout in 🐊Putout Editor.

Filesystem:

`diff
-["/", "/package.json"]
+["/", "/package.js"]
`

$3

`json
{
"plugins": []
}
`

$3

`js
export default {
plugins: [],
};
`

convert-js-to-json

Checkout in 🐊Putout Editor:

- Replacer;
- Scanner;

Filesystem:

`diff
-["/", "/package.js"]
+["/", "/package.json"]
`

$3

`json
{
"plugins": []
}
`

$3

`js
export default {
plugins: [],
};
``

License

MIT