Added support for passing Regex into CLI #14
Conversation
This will allow for passing the `from`/`to` parameters as regex in the format `\match\g` through the CLI. If pattern does not match a Regex it will fall back to passing through as a `String`.
1 similar comment
bin/cli.js
Outdated
| const from = argv._.shift(); | ||
| const to = argv._.shift(); | ||
| const from = getRegexOrString(argv._.shift()); | ||
| const to = getRegexOrString(argv._.shift()); |
There was a problem hiding this comment.
The to property can never be a Regex, so it should always be a regular string.
bin/cli.js
Outdated
| const getRegexOrString = value => { | ||
| if(!isRegexMatch.test(value)) return value; | ||
| const flags = value.replace(/.*\/([gimy]*)$/, '$1'); | ||
| const pattern = value.replace(new RegExp('^/(.*?)/'+flags+'$'), '$1'); |
There was a problem hiding this comment.
This code block will not pass the linter, could you run ESLint on the code to fix style inconsistencies please?
bin/cli.js
Outdated
| @@ -14,9 +14,18 @@ if (argv._.length < 3) { | |||
| process.exit(1); | |||
| } | |||
|
|
|||
| // Parse from/to as either a Regex or a string | |||
| const isRegexMatch = /.*\/([gimy]*)$/; | |||
There was a problem hiding this comment.
Slightly worried that this pattern might incorrectly identify for example paths as a regex. E.g. /some-path/g would match, but it could be a path string rather than a regex. Perhaps it'd be better to include a flag if you are passing in a regular expression as the from parameter, to be explicit and prevent accidental regex matches.
I'd propose the flag isRegex for this purpose.
There was a problem hiding this comment.
This is a good point, thanks for pointing this out. So should we use:
replace-in-file [-regex] from to some/file.js,some/**/glob.js
replace-in-file from [-isRegex] to some/file.js,some/**/glob.js
I'd hoped I could add array support onto all the parameters, but might be a bit too complicated for CLI options.
There was a problem hiding this comment.
I would say:
replace-in-file from to some/file.js,some/**/glob.js --isRegex
Where from then is the regular expression string.
Yes, agreed, the CLI and arrays is a bit hard. I figured at least to use the comma separated list for the files would be most useful.
- Added -isRegex parameter to explicitly state ‘from’ parameter is a regex - Removed regex support from ‘to’ parameter
|
Thanks that looks alright. Could you update the |
1 similar comment
|
Great, thanks! |
This will allow for passing the
from/toparameters as regex in the format/match/gthrough the CLI. If pattern does not match a Regex it will fall back to passing through as aString.