Linemod Core

Comment driven line modifications


Usage

``javascript
import { linemod } from 'linemod-core';
import pathModule from 'node:path';

await linemod(
[pathModule.resolve(__dirname, 'index.js')],
{ outputExtension: '.mjs' }
);
`

$3

`javascript
const { linemod } = await import('linemod-core');
`

API

$3

Takes an array of string file paths (paths), applies modifications to them and outputs them to the same destination with the specified extension (outputExtension)

$3

Same as linemod(), but takes a single string file path (path) rather than an array.

$3

Applies any modifications on the string input (content) and returns back the resulting string.

Available modifications

Linemods are added at the end of the line they are supposed to apply to.

$3

Prefixes the line with whatever is specified after the keyword:

`javascript
// linemod-add: import escape from 'stringify-entities';
`

Becomes:

`javascript
import escape from 'stringify-entities';
`

$3

Prefixes the line with whatever is specified after the keyword:

`javascript
const exportedMethod = () => {}; // linemod-prefix-with: export
`

Becomes:

`javascript
export const exportedMethod = () => {};
`

$3

Replaces the line with whatever is specified after the keyword:

`javascript
const escape = require('stringify-entities'); // linemod-replace-with: import escape from 'stringify-entities';
`

Becomes:

`javascript
import escape from 'stringify-entities';
`

$3

Simply removes the entire line.

Quite useful when combined with linemod-prefix-with:

`javascript
const exportedMethod = () => {}; // linemod-prefix-with: export
module.exports = { exportedMethod }; // linemod-remove
`

Becomes:

`javascript
export const exportedMethod = () => {};
``