@putout/plugin-declare
v4.0.0
Published
🐊Putout plugin adds ability to declare variables
Downloads
22,346
Maintainers
Readme
@putout/plugin-declare
🐊Putout plugin adds ability to declare variable that was not defined before, including:
- maybe:
maybeArray
,maybeFn
,maybeEmptyArray
; - wrap:
not
,id
,returns
; - fresh-import:
freshImport
,freshImportDefault
; fixtures
:readFixture
;- properties of
Object
; - wraptile;
- fullstore;
- currify;
- pipe-io;
- pullout;
- wait;
- simport;
- chalk;
- table;
Install
npm i putout @putout/plugin-declare -D
Add .putout.json
with:
{
"plugins": {
"declare": "on"
}
}
Rules
Use options:
- ✅
dismiss
for variables you don't want to declare; - ✅
declarations
to declare variables;
{
"rules": {
"declare": ["on", {
"declarations": {
"hello": "import {hello} from 'world'"
},
"dismiss": [
"assert",
"entries",
"parse",
"stringify",
"defineProperty",
"noop",
"join",
"keys",
"values",
"stopAll",
"once",
"putout",
"simport"
]
}]
}
}
assign
❌ Example of incorrect code
const hello = 'world';
const object = {};
assign(object, {
hello,
});
✅ Example of correct code
const hello = 'world';
const object = {};
const {assign} = Object;
assign(object, {
hello,
});
keys
❌ Example of incorrect code
const hello = 'world';
const object = {};
const allKeys = keys(object);
✅ Example of correct code
const hello = 'world';
const object = {};
const {keys} = Object;
const allKeys = keys(object);
values
❌ Example of incorrect code
const object = {};
const allValues = values(object);
✅ Example of correct code
const {values} = Object;
const object = {};
const allValues = values(object);
noop
❌ Example of incorrect code
noop();
✅ Example of correct code
const noop = () => {};
noop();
Types
❌ Example of incorrect code
const isFn = (a) => typeof a === 'function';
if (isFn(fn))
fn();
✅ Example of correct code
const isFn = (a) => typeof a === 'function';
if (isFn(fn))
fn();
Maybe
❌ Example of incorrect code
const a = [...maybeArray(b)];
✅ Example of correct code
const {isArray} = Array;
const maybeArray = (a) => isArray(a) ? a : [a];
const a = [...maybeArray(b)];
entries
❌ Example of incorrect code
entries([1, 2, 3]);
✅ Example of correct code
const {isArray} = Array;
const entries = (a) => isArray(a) ? a.entries() : Object.entries();
entries([1, 2, 3]);
License
MIT