Inflint NPM | npm.io

Inflint

Inflint is a tool which scans and verifies files and folders name conventions.

Inflint allows you to easily set file names convention in your repository.

Demo

Inflint

Installation

Globally

npm install --global inflint

Locally

npm install --save-dev inflint

Usage

$ inflint [options] [files]

Configuration

You can specify the configuration of Inflint through various options. Configuration can be set in the following files:

a package.json property: "inflint": {...}
a .inflintrc file in JSON or YAML format
a .inflintrc.json, .inflintrc.yaml, .inflintrc.yml, .inflintrc.js, .inflintrc.ts, or .inflintrc.cjs file
a inflint.config.js, inflint.config.ts or inflint.config.cjs CommonJS module exporting an object

If you set a TypeScript configuration file, you can use the configuration interface:

import { Config } from 'inflint';
const inflintConfig: Config = {
	...
}
export default inflintConfig;

You can set a configuration file using our wizard:

npx inflint --init

Rules format

When applying rules either via the CLI or other conifguration, you must follow the rules format. 1 and warn are warnings rules, 2 and error are errors rules. Each rule has key and value. The key represents the glob pattern. When a file matches the pattern, it will be enfocred by the rule. They rule value represents the rule enforcement. Rules enforcement format:

Set rules of files-existence: 1 | 2 | 'warn' | 'error' | [1] | [2] | ['warn'] | ['error']
Example: { 'src/**/*': 2 } → Inflint will emit error if there are any files/folders inside src folder
Set rules to match file names conventions: [1, <convention>] | [2, <convention>] | ['warn', <convention>]| ['error', <convention>]
Example: { 'src/**/*': [1, 'kebab-case'] } → Inflint will emit error if there are any files/folder with "kebab-case" convention name inside src folder
Set rules options: [1, <convention>(optional), <options>] | [2, <convention>(optional), <options>] | ['warn', <convention>(optional), <options>] | ['error', <convention>(optional), <options>]
Example1: { 'src/**/*': [1, { onlyFiles: true }] } → Inflint will emit error if there are any files inside src folder (and ignores folders if there are)
Example2: { 'src/**/*': [1, 'point.case', { onlyFiles: true }] } → Inflint will emit error if there are any files with "point-case" convention name inside src folder (and ignores folders if there are)

If you provide unknown convention which isn't a readymade one or a configured alias, Inflint will consider the "convention" as regex.

Rule option

You can set options for any rule, in order to get some customization.

onlyDirectories: Boolean (default: false)
Inflint will check the rule with directories only. Will skip files.
onlyFiles: Boolean (default: false)
Inflint will check the rule with files only. Will skip directories.
dot: Boolean (default: true)
Allow Inflint to match files and directories that begin with a period (.)
caseSensitiveMatch: Boolean (default: true)
Enables a case-sensitive mode for matching files.

File names conventions

CLI Rules

When adding rules via the CLI, you need to provide a valid JSON for the --rule argument. You can provide multiple rules. The JSON should follow the rules format described above.

Example: inflint --rule "{ \"src/**/*\": [1] }"

Aliases

You can use the readymade conventions, or you can add your own by applying aliases, via the CLI or other configuration. To use the aliases, simply use the alias name as you would use readymade convention. Aliases should be applied with the following format:

<alias_name>: <regex> Inflint will apply the alias name to match the provided regex.
Example: Applying the alias { myAlias: '^.*$' } and the rule { 'src/**/*': [2, 'myAlias'] } → Inflint will match any file/folder in src directory and validates the provided regex matches it.
<alias_name>: [<regex>, <regex_flags>] Inflint will apply the alias name to match the provided regex with given flags.
Example: { myAlias: ['^.*$', 'i'] } → Any rule applied with myAlias alias will try to match file names by the provided regex and the i regex flag.

CLI Aliases

When adding aliases via the CLI, you need to provide a valid JSON for the --alias argument. You can provide multiple aliases. The JSON should follow the aliases format described above.

Example: inflint --alias "{ \"myAlias\": \"^\\.\" }"

You can escape aliases regex with in the CLI if you prefix character with \\. "^\\." will match any string begins with dot (.)

CLI	Configuration key	Type	default	Description
-	`extends`	String	-	A path to configuration file to extend configurations from
`--no-inflintrc`	-	Boolean	`false`	Whether Inflint ignores any configuration file
`-c`, `--config`	-	String	-	The path to a configuration file which will be used by Inflint
`--rule`	`rules`	Above	-	Inflint rules to use against files
`--alias`	`aliases`	Above	-	Inflint aliases to use together with rules
`--ignore-path`	`ignorePath`	String	`.inflintignore`	Ignore file path Inflint will use to ignore patterns
`--no-ignore`	`ignore`	Boolean	`false`	Disable use of ignore files and patterns
`--ignore-pattern`	`ignorePatterns`	String[]	`[]`	Patterns of files to ignore (in addition to those in .inflintignore)
`--quiet`	`quiet`	Boolean	`false`	Whether to report errors only
`--max-warnings`	`maxWarnings`	Number	`0`	Number of warnings to trigger non-zero exit code
`--bail`	`bail`	Boolean or Number	`0`	Number of failures (errors) to make Inflint to exit. Setting "bail" to true is the same as setting "1"
`-o`, `--output-file`	`outputFile`	String	-	Specify file to write report to
`--color`, `--no-color`	-	Boolean	`true`	Force enabling/disabling of color
`--init`	-	Boolean	`false`	Run configuration initialization wizard
`-h`, `--help`	-	Boolean	`false`	Show help
`-v`, `--version`	-	Boolean	`false`	Output the version number
`--env-info`	-	Boolean	`false`	Output the environment version