@putout/operator-rename-files

????Putout operator adds ability to rename files to plugins.

Install

npm i putout @putout/operator-rename-files

API

If you want to create ????Putout plugin that will rename files according to your needs just use for ESM:

import {operator} from 'putout';

const {renameFiles} = operator;

export const {
    report,
    fix,
    scan,
} = renameFiles({
    type: 'module',
    mask: '*.mjs',
    rename(name) {
        return name.replace(/mjs$/, 'js');
    },
});

And for CommonJS:

module.exports = renameFiles({
    type: 'commonjs',
    mask: '*.cjs',
    rename(name) {
        return name.replace(/cjs$/, 'js');
    },
});

When you do not need to check type field of package.json, avoid type field:

module.exports = renameFiles({
    mask: '*.cjs',
    rename(name) {
        return name.replace(/cjs$/, 'js');
    },
});

renameFiles({mask, from, to})

You can pass from and to instead of rename for declarative renaming.

export const {
    report,
    fix,
    scan,
} = renameFiles({
    mask: '*.spec.*',
    from: 'spec',
    to: 'test',
});

renameFiles({from, to, near})

Rename files located near package.json:

export const {
    report,
    fix,
    scan,
} = renameFiles({
    from: 'madrun.js',
    to: '.madrun.js',
    near: 'package.json',
});

You can also use redlint directly.

License

MIT

Current Tags

6.2.1 ... latest (2 months ago)