@putout/plugin-madrun

CLI tool to run multiple npm-scripts in a madly comfortable way.

(c) Madrun

🐊Putout plugin adds ability to fix issues with Madrun config file.

Install

npm i putout @putout/plugin-madrun -D

Rules

• ✅ add-cut-env;
• ✅ add-fix-lint;
• ✅ add-function;
• ✅ add-missing-quotes-to-watcher;
• ✅ add-run;
• ✅ call-run;
• ✅ convert-args-to-scripts;
• ✅ convert-cut-env-to-run;
• ✅ convert-lint-lib;
• ✅ convert-nyc-to-c8
• ✅ convert-run-argument;
• ✅ convert-run-to-cut-env;
• ✅ convert-to-async;
• ✅ declare;
• ✅ remove-check-duplicates-from-test;
• ✅ remove-putout;
• ✅ remove-useless-array-in-run;
• ✅ remove-useless-string-conversion;
• ✅ rename-eslint-to-putout;
• ✅ rename-series-to-run;
• ✅ set-lint-dot;
• ✅ set-report-lcov;

Config

{
    "rules": {
        "madrun/add-function": "on",
        "madrun/add-fix-lint": "on",
        "madrun/add-run": "on",
        "madrun/add-missing-quotes-to-watcher": "on",
        "madrun/add-cut-env": "on",
        "madrun/call-run": "on",
        "madrun/convert-run-argument": "on",
        "madrun/convert-args-to-scripts": "on",
        "madrun/convert-run-to-cut-env": "on",
        "madrun/convert-cut-env-to-run": "on",
        "madrun/rename-series-to-run": "on",
        "madrun/rename-eslint-to-putout": "on",
        "madrun/set-lint-dot": "on",
        "madrun/convert-to-async": "on",
        "madrun/convert-nyc-to-c8": "on",
        "madrun/set-report-lcov": "on",
        "madrun/remove-check-duplicates-from-test": "on",
        "madrun/remove-useless-array-in-run": "on",
        "madrun/remove-useless-string-conversion": "on"
    }
}

add-function

❌ Example of incorrect code

module.exports = {
    hello: 'world',
};

✅ Example of correct code

module.exports = {
    hello: () => 'world',
};

add-fix-lint

❌ Example of incorrect code

const {run} = require('madrun');

module.exports = {
    lint: 'putout lib test',
};

✅ Example of correct code

const {run} = require('madrun');

module.exports = {
    'lint': 'putout lib test',
    'fix:lint': run('lint', '--fix'),
};

add-missing-quotes-to-watcher

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

export default {
    'watch:test': async () => await run('watcher', await run('test')),
};

✅ Example of correct code

export default {
    'watch:test': async () => await run('watcher', `"${await run('test')}"`),
};

add-run

❌ Example of incorrect code

module.exports = {
    lint: 'putout lib test',
};

✅ Example of correct code

const {run} = require('madrun');

module.exports = {
    lint: 'putout lib test',
};

add-cut-env

❌ Example of incorrect code

export default {
    'test': () => [env, 'test:only'],
    'test:only': () => [env, 'npm test'],
};

✅ Example of correct code

import {cutEnv} from 'madrun';

export default {
    'test': async () => [testEnv, await cutEnv('test:only')],
    'test:only': () => [env, 'npm test'],
};

convert-run-argument

❌ Example of incorrect code

module.exports = {
    hello: () => run(['a']),
};

✅ Example of correct code

module.exports = {
    hello: () => run('a'),
};

convert-args-to-scripts

Check out in 🐊Putout Editor.

❌ Example of incorrect code

export default {
    build: () => 'tsup',
    wisdom: () => run('build', 'test', 'test:dts'),
};

✅ Example of correct code

export default {
    build: () => 'tsup',
    wisdom: () => run(['build', 'test', 'test:dts']),
};

convert-run-to-cut-env

❌ Example of incorrect code

export default {
    'test': () => [env, 'npm test'],
    'test:only': () => 'npm test',
    'coverage': async () => [env, await run('test')],
    'coverage:only': async () => [env, await run('test:only')],
};

✅ Example of correct code

export default {
    'test': () => [env, 'npm test'],
    'test:only': () => 'npm test',
    'coverage': async () => [env, await cutEnv('test')],
    'coverage:only': async () => [env, await run('test:only')],
};

convert-cut-env-to-run

❌ Example of incorrect code

export default {
    'test': () => [env, 'npm test'],
    'test:only': () => 'npm test',
    'coverage': async () => [env, await cutEnv('test')],
    'coverage:only': async () => [env, await cutEnv('test:only')],
};

✅ Example of correct code

export default {
    'test': () => [env, 'npm test'],
    'test:only': () => 'npm test',
    'coverage': async () => [env, await cutEnv('test')],
    'coverage:only': async () => [env, await run('test:only')],
};

rename-eslint-to-putout

❌ Example of incorrect code

module.exports = {
    lint: 'eslint lib test --ignore test/fixture',
};

✅ Example of correct code

module.exports = {
    lint: 'putout lib test',
};

set-lint-dot

❌ Example of incorrect code

module.exports = {
    lint: 'putout lib test',
};

✅ Example of correct code

module.exports = {
    lint: 'putout .',
};

convert-to-async

❌ Example of incorrect code

module.exports = {
    lint: () => String(run('hello')),
};

✅ Example of correct code

module.exports = {
    lint: async () => String(await run('hello')),
};

convert-nyc-to-c8

❌ Example of incorrect code

export default {
    coverage: () => 'nyc npm test',
    report: () => `nyc report --reporter=text-lcov | coveralls`,
};

✅ Example of correct code

export default {
    coverage: () => 'c8 npm test',
    report: 'c8 report --reporter=lcov',
};

set-report-lcov

❌ Example of incorrect code

export default {
    report: () => `c8 report --reporter=text-lcov | coveralls || true`,
};

✅ Example of correct code

export default {
    report: 'c8 report --reporter=lcov',
};

remove-check-duplicates-from-test

❌ Example of incorrect code

export default {
    test: () => 'tape -d *.js',
};

✅ Example of correct code

export default {
    test: () => 'tape *.js',
};

remove-useless-array-in-run

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

export default {
    time: async () => await run(['lint:fresh', '-f time']),
};

✅ Example of correct code

export default {
    time: async () => await run('lint:fresh', '-f time'),
};

remove-useless-string-conversion

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

export default {
    time: async () => [testEnv, String(await cutEnv('test:raw'))],
};

✅ Example of correct code

export default {
    time: async () => [testEnv, await cutEnv('test:raw')],
};

declare

❌ Example of incorrect code

export default {
    coverage: async () => [env, `c8 ${await cutEnv('test')}`],
};

✅ Example of correct code

import {cutEnv} from 'madrun';

export default {
    coverage: async () => [env, `c8 ${await cutEnv('test')}`],
};

License

MIT