@frsource/frs-replace 4.1.0 → 5.0.0

package/bin/cli.js

@@ -1,148 +0,0 @@
-#!/usr/bin/env node
-const replaceSync = require('../sync');
-
-(
-  ~process.argv.indexOf('--no-stdin')
-    ? Promise.resolve()
-    : require('get-stdin')()
-).then((stdin) => {
-  const isPiped = !!stdin
-
-  if (isPiped) {
-    process.argv.push('-c')
-    process.argv.push(stdin) // threat piped data as value for --content option
-  }
-
-  const isContentPresent = ~process.argv.indexOf('--content') || ~process.argv.indexOf('-c')
-  const isHelpPresent = ~process.argv.indexOf('--help') || ~process.argv.indexOf('-h')
-
-  const argv = require('yargs')
-    .parserConfiguration({
-      'camel-case-expansion': false
-    })
-    .scriptName('frs-replace')
-    .usage('$0 <needle> <replacement> [options]', 'Replace matching parts of string with replacement string/function', (yargs) => {
-      yargs
-        .positional('needle', {
-          describe: 'String which is passed as a first parameter to RegExp constructor',
-          type: 'string',
-          demand: true
-        })
-        .positional('replacement', {
-          describe: 'String or path to replacement function file (see --replace-fn switch for details)',
-          type: 'string',
-          demand: true
-        })
-        .example('$0 a b -i foo.js -o foo_replaced.js',
-          'Replaces all "a" occurences with "b" from given foo.js and save result to foo_replaced.js')
-        .example('<read file> | $0 a b > <output-file-path>',
-          'Replaces all "a" occurences with "b" from stream and save it to output file')
-        .example('<read file> | $0 a b | <next-command>',
-          'Replaces all "a" occurences with "b" from stream and pass it through the stream to next command')
-        .example('$0 a b -i foo.js | <next-command>',
-          'Both pipe & options styles can be mixed together, here - getting input from "i" argument and passing output down the stream to next command')
-        .example('$0 a b --content abcd -o foo_replaced.js',
-          'Replace all "a" occurences with "b" in given "abcd" and save result (which is "bbcd") to foo_replaced.js')
-    })
-
-    .option('f')
-    .alias('f', 'flags')
-    .describe('f', 'RegExp flags used together with `needle` positional (supporting g, i & m)')
-    .nargs('f', 1)
-    .choices('f', ['', 'g', 'm', 'i', 'gm', 'gi', 'mi', 'mg', 'ig', 'im', 'gmi', 'gim', 'mig', 'mgi', 'igm', 'img'])
-    .default('f', 'g')
-    .coerce('f', arg => arg.trim())
-    .option('i', { demandOption: !isContentPresent && !isHelpPresent })
-    .alias('i', 'input')
-    .describe('i', 'Path to files or fast-glob pattern pointing to files to read & replace from')
-    .array('i')
-
-    .option('i-read-opts')
-    .describe('i-read-opts', 'Passed to fs.readFileSync when reading input file')
-    .default('i-read-opts', undefined, 'utf8') // will use node's default value
-    .implies('i-read-opts', 'i')
-
-    .option('i-glob-opts')
-    .describe('i-glob-opts', 'Passed to fast-glob.sync when resolving glob patterns')
-    .implies('i-glob-opts', 'i')
-
-    .option('stdin')
-    .describe('stdin', 'Wait for stdin input (should be set to false when used in non-interactive terminals)')
-    .boolean('stdin')
-    .default('stdin', true)
-
-    .option('c', { demandOption: isContentPresent })
-    .alias('c', 'content')
-    .describe('c', 'Content to be replaced (takes precedence over stream & file input)')
-    .string('c')
-    .nargs('c', 1)
-
-    .option('s')
-    .alias('s', 'strategy')
-    .describe('s', `output file generation strategy.
-\`join\` - join all input files and saves single file using "output" option as it's path,
-\`preserve-structure\` - when replacing files content copies them over to the directory specified by "output" option.
-\`flatten\` - same as \`preserve-structure\` but flattens the directory structure`)
-    .nargs('s', 1)
-    .choices('s', ['join', 'flatten', 'preserve-structure'])
-    .default('s', 'join')
-    .coerce('s', arg => arg.trim())
-
-    .option('o')
-    .alias('o', 'output')
-    .describe('o', 'Output file name/path (replaces the file if it already exists and creates any intermediate directories if they don\'t already exist) or (when used together with `strategy` = `flatten` or `preserve-structure`) path to the output directory')
-    .string('o')
-    .nargs('o', 1)
-
-    .option('o-write-opts')
-    .describe('o-write-opts', 'Passed as options argument of write\'s .sync method')
-    .default('o-write-opts', undefined, 'utf8') // will use node's default value
-    .implies('o-write-opts', 'o')
-
-    .option('o-join-str')
-    .describe('o-join-str', 'String used when joining multiple files (use it together with either `output` or `stdout` option)')
-    .default('o-join-str', undefined, 'newline (\\n)') // will use node's default value
-
-    .option('stdout')
-    .describe('stdout', 'Force sending output on stdout')
-    .boolean('stdout')
-    .default('stdout', isPiped, 'true when piped input present, false otherwise')
-
-    .option('r')
-    .alias('r', 'replace-fn')
-    .describe('r', 'Treat replacement argument as path to file containing replacement function')
-    .boolean('r')
-
-    .help('h')
-    .alias('h', 'help')
-
-    .version('v')
-    .alias('v', 'version')
-
-    .epilog('Brought to you with open-source love by FRSource')
-    .argv
-
-  try {
-    const result = replaceSync({
-      input: argv.i,
-      inputReadOptions: argv['i-read-opts'],
-      inputGlobOptions: argv['i-glob-opts'],
-      content: argv.c,
-      strategy: argv.strategy,
-      output: argv.o,
-      outputWriteOptions: argv['o-write-opts'],
-      outputJoinString: argv['o-join-str'],
-      needle: new RegExp(argv.needle, argv.f),
-      replacement: argv.r ? require(require('path').resolve(argv.replacement)) : argv.replacement
-    })
-
-    if (argv.stdout) {
-      process.stdout.write(result[0][1])
-    }
-
-    return process.exit()
-  } catch (e) /* istanbul ignore next */ {
-    process.stderr.write(e.toString())
-    return process.exit(1)
-  }
-})

package/index.js

@@ -1,4 +0,0 @@
-module.exports = {
-  async: require('./src/async'),
-  sync: require('./src/sync')
-}

package/src/async.js

@@ -1,104 +0,0 @@
-const write = require('write')
-const path = require('path')
-const fs = require('fs')
-const fastGlob = require('fast-glob')
-const { writeError, getReplaceFn } = require('./utils')
-
-const inputStrategyMap = {
-  join: (results, outputJoinString) =>
-    results.then(results => [
-      Promise.all(results).then(results => {
-        const len = results.length
-        let result = (results[0] && results[0][1]) || ''
-        for (let i = 1; i < len; ++i) {
-          result += outputJoinString + results[i][1]
-        }
-        return ['', result]
-      })
-    ]),
-  flatten: results =>
-    results.then(results => results.map(async result => {
-      result = await result
-      result[0] = result[0].substring(result[0].lastIndexOf(path.sep))
-      return result
-    })),
-  'preserve-structure': results => results
-}
-
-const multipleFilesOutput = (results, output, outputWriteOptions) => {
-  return results.then(results => results.map(
-    async result => {
-      result = await result
-      result[0] = path.join(output, result[0])
-      await write(result[0], result[1], outputWriteOptions)
-      return result
-    }
-  ))
-}
-
-const outputStrategyMap = {
-  join: (results, output, outputWriteOptions) =>
-    results.then(results => [
-      results[0].then(async result => {
-        await write(output, result[1], outputWriteOptions)
-        result[0] = output
-        return result
-      })
-    ]),
-  flatten: multipleFilesOutput,
-  'preserve-structure': multipleFilesOutput
-}
-
-module.exports = async ({
-  input,
-  inputReadOptions = 'utf8',
-  inputGlobOptions,
-  content,
-  strategy = 'join',
-  output,
-  outputWriteOptions = 'utf8',
-  outputJoinString = '\n',
-  needle,
-  replacement
-}) => {
-  let results
-  const replaceFn = getReplaceFn(needle, replacement)
-
-  if (content !== undefined) {
-    results = Promise.resolve([['', replaceFn(content)]])
-  } else if (input !== undefined) {
-    const fileStream = fastGlob.stream(input, inputGlobOptions)
-    const replacePromises = []
-
-    fileStream.on('error', writeError)
-    fileStream.on('data', path => replacePromises.push(new Promise((resolve, reject) =>
-      fs.readFile(path, inputReadOptions, (error, data) => {
-        /* istanbul ignore next */
-        if (error) return reject(error)
-
-        resolve([path, replaceFn(data)])
-      })
-    )))
-    results = new Promise(resolve =>
-      fileStream.once('end', () =>
-        resolve(replacePromises)
-      )
-    ).catch(writeError)
-  } else {
-    writeError('at least one input source must be defined!')
-  }
-
-  if (!inputStrategyMap[strategy]) writeError('unsupported strategy used! Possible values are: "join", "preserve-structure" or "flatten"')
-  results = inputStrategyMap[strategy](results, outputJoinString)
-
-  if (output !== undefined) {
-    output = path.normalize(output)
-    if (typeof outputWriteOptions === 'string') {
-      outputWriteOptions = { encoding: outputWriteOptions }
-    }
-
-    results = outputStrategyMap[strategy](results, output, outputWriteOptions)
-  }
-
-  return results
-}

package/src/sync.js

@@ -1,88 +0,0 @@
-const write = require('write')
-const path = require('path')
-const fs = require('fs')
-const fastGlob = require('fast-glob')
-
-const { writeError, getReplaceFn } = require('./utils')
-
-const inputStrategyMap = {
-  join: (results, len, outputJoinString) => {
-    let result = (results[0] && results[0][1]) || ''
-    for (let i = 1; i < len; ++i) {
-      result += outputJoinString + results[i][1]
-    }
-    return [[['', result]], 1]
-  },
-  flatten: (results, len) => {
-    for (let i = 0; i < len; ++i) {
-      const result = results[i]
-      result[0] = result[0].substring(result[0].lastIndexOf(path.sep))
-    }
-    return [results, len]
-  },
-  'preserve-structure': (...args) => args
-}
-
-const multipleFilesOutputStrategy = (results, len, output, outputWriteOptions) => {
-  for (let i = 0; i < len; ++i) {
-    const result = results[i]
-    result[0] = path.join(output, result[0])
-    write.sync(result[0], result[1], outputWriteOptions)
-  }
-  return results
-}
-
-const outputStrategyMap = {
-  join: (results, len, output, outputWriteOptions) => {
-    write.sync(output, results[0][1], outputWriteOptions)
-    results[0][0] = output
-    return results
-  },
-  flatten: multipleFilesOutputStrategy,
-  'preserve-structure': multipleFilesOutputStrategy
-}
-
-module.exports = ({
-  input,
-  inputReadOptions = 'utf8',
-  inputGlobOptions,
-  content,
-  strategy = 'join',
-  output,
-  outputWriteOptions = 'utf8',
-  outputJoinString = '\n',
-  needle,
-  replacement
-}) => {
-  let results
-  const replaceFn = getReplaceFn(needle, replacement)
-
-  if (content !== undefined) {
-    results = [['', replaceFn(content)]]
-  } else if (input !== undefined) {
-    results = []
-    const files = fastGlob.sync(input, inputGlobOptions)
-    const len = files.length
-    for (let i = 0; i < len; ++i) {
-      const filePath = files[i]
-      results.push([filePath, replaceFn(fs.readFileSync(filePath, inputReadOptions))])
-    }
-  } else {
-    writeError('at least one input source must be defined!')
-  }
-
-  let len
-  if (!inputStrategyMap[strategy]) writeError('unsupported strategy used! Possible values are: "join", "preserve-structure" or "flatten"');
-  [results, len] = inputStrategyMap[strategy](results, results.length, outputJoinString)
-
-  if (output !== undefined) {
-    output = path.normalize(output)
-    if (typeof outputWriteOptions === 'string') {
-      outputWriteOptions = { encoding: outputWriteOptions }
-    }
-
-    results = outputStrategyMap[strategy](results, len, output, outputWriteOptions)
-  }
-
-  return results
-}

package/src/utils.js

@@ -1,22 +0,0 @@
-const writeError = msg => { throw new Error(`@frsource/frs-replace :: ${msg}`) }
-
-const getReplaceFn = (needle, replacement) =>
-  typeof needle === 'string'
-    ? content => {
-      const needleLen = needle.length
-      let result = ''
-      let i
-      let endIndex = 0
-
-      while ((i = content.indexOf(needle, endIndex)) !== -1) {
-        result += content.slice(endIndex, i) + replacement
-        endIndex = i + needleLen
-      }
-
-      result += content.slice(endIndex, content.length)
-
-      return result
-    }
-    : content => content.replace(needle, replacement)
-
-module.exports = { writeError, getReplaceFn }

package/sync.js

@@ -1 +0,0 @@
-module.exports = require('./src/sync')