@codemod-utils/files
Advanced tools
Utilities for handling files
@codemod-utils/files wraps the synchronous methods from node:fs, node:path, and glob to help you update many files in the same way.
Many of the methods make use of the file path, a string that represents the location of a file. Therefore, I recommend learning findFiles first, as it returns the paths of all files that match the search criteria.
Copies files from one directory (source) to another (destination). Creates the destination directory if it doesn't exist.
Copy LICENSE.md and README.md from the project root to the folder ember-container-query.
import { copyFiles } from '@codemod-utils/files';
const filePathMap = new Map([
['LICENSE.md', 'ember-container-query/LICENSE.md'],
['README.md', 'ember-container-query/README.md'],
]);
copyFiles(filePathMap, {
projectRoot,
});
Creates the directories specified in the file path, if they don't exist yet.
⚠️ Likely, you won't need this method but createFiles instead.
Create the folder ember-container-query if it doesn't exist.
import { createDirectory } from '@codemod-utils/files';
const newFilePath = 'ember-container-query/LICENSE.md';
const destination = join(projectRoot, newFilePath);
createDirectory(destination);
Create files. Creates the destination directory if it doesn't exist.
Create LICENSE.md and README.md in the project root.
import { createFiles } from '@codemod-utils/files';
const fileMap = new Map([
['LICENSE.md', 'The MIT License (MIT)'],
['README.md', '# ember-container-query'],
]);
createFiles(fileMap, {
projectRoot,
});
Often, you will want a codemod step to apply to select files. findFiles provides the paths of all files that match your search criteria (i.e. glob pattern, ignore list, and project root). The paths are sorted in alphabetical order.
Find all component templates in an Ember app.
import { findfiles } from '@codemod-utils/files';
const filePaths = findFiles('app/components/**/*.hbs', {
projectRoot,
});
You can provide ignoreList, an array of file paths or glob patterns, to exclude files.
Find all component classes in an Ember app.
import { findfiles } from '@codemod-utils/files';
const filePaths = findFiles('app/components/**/*.{js,ts}', {
ignoreList: ['**/*.d.ts'],
projectRoot,
});
To look for multiple types of files, you can pass an array of glob patterns (pattern A or pattern B or ...).
import { findfiles } from '@codemod-utils/files';
const filePaths = findFiles([
'LICENSE.md',
'README.md',
], {
projectRoot,
});
import { findfiles } from '@codemod-utils/files';
const filePaths = findFiles([
'app/components/**/*.hbs',
'tests/integration/components/**/*-test.{js,ts}',
], {
projectRoot,
});
Creates a mapping of file paths, which can then be passed to copyFiles or moveFiles.
Map LICENSE.md to ember-container-query/LICENSE.md (and similarly for README.md).
import { mapFilePaths } from '@codemod-utils/files';
const filePaths = ['LICENSE.md', 'README.md'];
const filePathMap = mapFilePaths(filePaths, {
from: '',
to: 'ember-container-query',
});
Moves files from one directory (source) to another (destination). Creates the destination directory if it doesn't exist. Removes the source directory if it is empty.
Move LICENSE.md and README.md from the project root to a folder named ember-container-query.
import { moveFiles } from '@codemod-utils/files';
const filePathMap = new Map([
['LICENSE.md', 'ember-container-query/LICENSE.md'],
['README.md', 'ember-container-query/README.md'],
]);
moveFiles(filePathMap, {
projectRoot,
});
Parses a file path, similarly to parse() from node:path, but correctly handles file extensions with more than one ., e.g. .d.ts and .css.d.ts.
import { parseFilePath } from '@codemod-utils/files';
const filePath = 'src/components/navigation-menu.d.ts';
const { base, dir, ext, name } = parseFilePath(filePath);
// base -> 'navigation-menu.d.ts'
// dir -> 'src/components'
// ext -> '.d.ts'
// name -> 'navigation-menu'
Removes the directories specified in the file path, if they are empty.
⚠️ Likely, you won't need this method but removeFiles instead.
Remove the folder ember-container-query if it is empty.
import { removeDirectoryIfEmpty } from '@codemod-utils/files';
const filePath = 'ember-container-query/LICENSE.md';
removeDirectoryIfEmpty(filePath, {
projectRoot,
});
Removes files. Removes the source directory if it is empty.
Remove LICENSE.md and README.md from the project root.
import { removeFiles } from '@codemod-utils/files';
const filePaths = ['LICENSE.md', 'README.md'];
removeFiles(filePaths, {
projectRoot,
});
Forms a new file path by altering the path's directory.
Prepare to move components from addon to ember-container-query/src.
import { renamePathByDirectory } from '@codemod-utils/files';
const oldFilePath = 'addon/components/container-query.hbs';
const newFilePath = renamePathByDirectory(oldFilePath, {
from: 'addon',
to: 'ember-container-query/src',
});
// newFilePath -> 'ember-container-query/src/components/container-query.hbs'
See the Contributing guide for details.
This project is licensed under the MIT License.
FAQs
Utilities for handling files
We found that @codemod-utils/files demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 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.