Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
fs-transform
Advanced tools
Fast, rule based, file system transformations.
Using fs-transform
is fairly straight forward, here's an example that
illustrates its core features:
// 1. Require the transformer class
var Transformer = require('fs-transform');
// 2. Define an array of transform rules
var rules = [
// 2.1 Copy files
{
action: 'copy',
source: 'source/file',
dest: 'dest/file'
},
// 2.2 Rename files
{
action: 'rename',
source: 'source/file',
dest: 'dest/file'
},
// 2.3 Exclude files from all subsequent searches
{
action: 'exclude',
files: ['A.txt', 'B.dmg']
},
// 2.4 Search and Replace in Files
// Note: this is applied globally to all files in the root directory
{
action: 'replace',
search: 'foo',
replace: 'bar',
// Use `exclude` property to define a set of files to exclude for this
// search and replace
exclude: [
'another/file',
'a/dir/'
]
}
];
// Execute the transformation on the given root directory (/root/path)
Transformer.transform('/root/path', rules, function (err) {
// Handle errors if they arise, and move on!
});
fs-transform
ships with three basic transform rule implementations, or
actions, they are:
copy
- Copies a filerename
- Renames a filereplace
- Performs a global search and replace (without regex)If you need custom transformations, you can easily add them by using a
Transformer
instance, like so:
var Transformer = require('fs-transform');
// 1. Instantiate a new transformer with a root directory and rules
var transformer = new Transformer('/root/dir', rules);
// 2. Add a custom rule action implementation
transformer.setAction('custom-action', function (rule, cb) {
// This function will be applied to the `transformer` object itself;
// which means you can use Transformer prototype methods directly, like this:
this.addWarning(rule, 'Foo does nothing').
// When you are done with handling your action, make sure to execute
// the callback.
if (rule.errorOut) {
cb(new Error('Foo failed.'));
}
cb();
});
The library is fairly intelligent about when and how to apply transforms. For instance, if you attempt to perform a rename but the source file doesn't exist the library will skip that rule and issue a warning.
After a transformation completes you can access all of the warnings generated by the library like so:
Transformer.transform('/root', rules, function (err, transformer) {
// Look here for a list of all the warnings
var warnings = transformer.warnings;
// Each warning will have both a `rule` and a `message` field so you can
// narrow down why the warning occurred.
warnings[0].rule;
warnings[0].message;
});
Below is a complete listing of the warnings that can be generated during a transform pass, by rule type:
Copy and rename perform the same checks and have the same behavior when issuing warnings. The warnings, in order of precedence, are:
'Missing source file.'
- if the rule.source
was not a string.'Missing destination file.'
- if the rule.dest
was not a string.'Source file does not exist.'
- if the given path to the source file did not
exist on the filesystem.'Overwriting destination file.'
- if the given destination file exists and
has been overwritten by the operation.'Search pattern not specified.'
- The given rule.search
was not a string.'Replacement not specified.'
- The given rule.replace
was not a string.'Excludes not supplied as an array, omitting.'
- The given rule.exclude
was given, but it was not an array, and will thus be ignored.'Search did not return any results.'
- The given rule.search
could not be
found in any file under the root directory.'Unused exclude.'
- An exclude was given that was never used to exclude a
file from the search.'All results were excluded.'
- The given set of excludes ended up removing
all of the files from the search results.fs-transform
performs all of its work in a temporary directory so it can
gracefully fail if an error occurs (leaving the root directory as it was before
the transforms were applied).
For further safety you can perform transformations in "dry run mode". Using it is rather simple:
Transformer.dry('/root/directory', myRules, function (err, transformer) {
// Two things to not:
//
// 1) Check to see if errors are reported in `err`
//
// 2) The `transformer` now has all the same information as it would during
// an actual run!
});
fs-transform
allows you to get a full recursive diff between the root
before transformations were applied, and the root after. Here's an example of
how to get the full text diff:
Transformer.dry('/root/directory', myRules, function (err, transformer) {
// Get and log the diff:
var fullDiff = transformer.getDiff();
console.log(fullDiff);
});
If you'd like to contribute to the library please abide by the following rules:
npm run doc
,
then open'doc/index.html' in a browser).npm test
).MIT
FAQs
Fast, rule based, file system transformations.
The npm package fs-transform receives a total of 4 weekly downloads. As such, fs-transform popularity was classified as not popular.
We found that fs-transform demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.