Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

Commit

Permalink
feat: make cli expect array for rules dir (#3788)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ggarek
ggarek authored and Josh Goldberg committed Nov 5, 2018
1 parent 61b0826 commit 1e9ed49
Showing 1 changed file with 60 additions and 35 deletions.
95 changes: 60 additions & 35 deletions src/tslintCli.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ const options: Option[] = [
as in the non-list case, and the rest of the list are options passed
to the rule that will determine what it checks for (such as number
of characters for the max-line-length rule, or what functions to ban
for the ban rule).`,
for the ban rule).`
},
{
short: "e",
Expand All @@ -81,28 +81,28 @@ const options: Option[] = [
description: dedent`
A filename or glob which indicates files to exclude from linting.
This option can be supplied multiple times if you need multiple
globs to indicate which files to exclude.`,
globs to indicate which files to exclude.`
},
{
name: "fix",
type: "boolean",
describe: "fixes linting errors for select rules (this may overwrite linted files)",
description: "Fixes linting errors for select rules. This may overwrite linted files.",
description: "Fixes linting errors for select rules. This may overwrite linted files."
},
{
name: "force",
type: "boolean",
describe: "return status code 0 even if there are lint errors",
description: dedent`
Return status code 0 even if there are any lint errors.
Useful while running as npm script.`,
Useful while running as npm script.`
},
{
short: "i",
name: "init",
type: "boolean",
describe: "generate a tslint.json config file in the current working directory",
description: "Generates a tslint.json config file in the current working directory.",
description: "Generates a tslint.json config file in the current working directory."
},
{
short: "o",
Expand All @@ -111,25 +111,25 @@ const options: Option[] = [
describe: "output file",
description: dedent`
A filename to output the results to. By default, tslint outputs to
stdout, which is usually the console where you're running it from.`,
stdout, which is usually the console where you're running it from.`
},
{
name: "outputAbsolutePaths",
type: "boolean",
describe: "whether or not outputted file paths are absolute",
description: "If true, all paths in the output will be absolute.",
description: "If true, all paths in the output will be absolute."
},
{
short: "r",
name: "rules-dir",
type: "string",
type: "array",
describe: "rules directory",
description: dedent`
An additional rules directory, for user-created rules.
tslint will always check its default rules directory, in
node_modules/tslint/lib/rules, before checking the user-provided
rules directory, so rules in the user-provided rules directory
with the same name as the base rules will not be loaded.`,
with the same name as the base rules will not be loaded.`
},
{
short: "s",
Expand All @@ -142,21 +142,22 @@ const options: Option[] = [
writing it to stdout or the file passed in --out. The default
directory, node_modules/tslint/build/formatters, will always be
checked first, so user-created formatters with the same names
as the base formatters will not be loaded.`,
as the base formatters will not be loaded.`
},
{
short: "t",
name: "format",
type: "string",
describe: "output format (prose, json, stylish, verbose, pmd, msbuild, checkstyle, vso, fileslist, codeFrame)",
describe:
"output format (prose, json, stylish, verbose, pmd, msbuild, checkstyle, vso, fileslist, codeFrame)",
description: dedent`
The formatter to use to format the results of the linter before
outputting it to stdout or the file passed in --out. The core
formatters are prose (human readable), json (machine readable)
and verbose. prose is the default if this option is not used.
Other built-in options include pmd, msbuild, checkstyle, and vso.
Additional formatters can be added and used if the --formatters-dir
option is set.`,
option is set.`
},
{
name: "test",
Expand All @@ -167,7 +168,7 @@ const options: Option[] = [
match the expected output in .lint files. Automatically loads the
tslint.json files in the directories as the configuration file for
the tests. See the full tslint documentation for more details on how
this can be used to test custom rules.`,
this can be used to test custom rules.`
},
{
short: "p",
Expand All @@ -178,23 +179,23 @@ const options: Option[] = [
The path to the tsconfig.json file or to the directory containing
the tsconfig.json file. The file will be used to determine which
files will be linted. This flag also enables rules that require the
type checker.`,
type checker.`
},
{
short: "q",
name: "quiet",
type: "boolean",
describe: "hide errors on lint",
description: "If true, hides warnings from linting output.",
description: "If true, hides warnings from linting output."
},
{
name: "type-check",
type: "boolean",
describe: "(deprecated) check for type errors before linting the project",
description: dedent`
(deprecated) Checks for type errors before linting a project.
--project must be specified in order to enable type checking.`,
},
--project must be specified in order to enable type checking.`
}
];

const builtinOptions: Option[] = [
Expand All @@ -203,15 +204,15 @@ const builtinOptions: Option[] = [
name: "version",
type: "boolean",
describe: "current version",
description: "The current version of tslint.",
description: "The current version of tslint."
},
{
short: "h",
name: "help",
type: "boolean",
describe: "display detailed help",
description: "Prints this help message.",
},
description: "Prints this help message."
}
];

commander.version(Linter.VERSION, "-v, --version");
Expand All @@ -227,9 +228,21 @@ for (const option of options) {

commander.on("--help", () => {
const indent = "\n ";
const optionDetails = options.concat(builtinOptions).map((o) =>
`${optionUsageTag(o)}:${o.description.startsWith("\n") ? o.description.replace(/\n/g, indent) : indent + o.description}`);
console.log(`tslint accepts the following commandline options:\n\n ${optionDetails.join("\n\n ")}\n\n`);
const optionDetails = options
.concat(builtinOptions)
.map(
o =>
`${optionUsageTag(o)}:${
o.description.startsWith("\n")
? o.description.replace(/\n/g, indent)
: indent + o.description
}`
);
console.log(
`tslint accepts the following commandline options:\n\n ${optionDetails.join(
"\n\n "
)}\n\n`
);
});

// Hack to get unknown option errors to work. https://github.com/visionmedia/commander.js/pull/121
Expand All @@ -238,24 +251,34 @@ commander.args = parsed.args;
if (parsed.unknown.length !== 0) {
(commander.parseArgs as (args: string[], unknown: string[]) => void)([], parsed.unknown);
}
const argv = commander.opts() as any as Argv;
const argv = (commander.opts() as any) as Argv;

if (!(argv.init || argv.test !== undefined || argv.project !== undefined || commander.args.length > 0)) {
if (
!(
argv.init ||
argv.test !== undefined ||
argv.project !== undefined ||
commander.args.length > 0
)
) {
console.error("No files specified. Use --project to lint a project folder.");
process.exit(1);
}

if (argv.typeCheck) {
console.warn("--type-check is deprecated. You only need --project to enable rules which need type information.");
console.warn(
"--type-check is deprecated. You only need --project to enable rules which need type information."
);
if (argv.project === undefined) {
console.error("--project must be specified in order to enable type checking.");
process.exit(1);
}
}

const outputStream: NodeJS.WritableStream = argv.out === undefined
? process.stdout
: fs.createWriteStream(argv.out, {flags: "w+", mode: 420});
const outputStream: NodeJS.WritableStream =
argv.out === undefined
? process.stdout
: fs.createWriteStream(argv.out, { flags: "w+", mode: 420 });

run(
{
Expand All @@ -273,24 +296,26 @@ run(
quiet: argv.quiet,
rulesDirectory: argv.rulesDir,
test: argv.test,
typeCheck: argv.typeCheck,
typeCheck: argv.typeCheck
},
{
log(m) {
outputStream.write(m);
},
error(m) {
process.stderr.write(m);
},
})
.then((rc) => {
}
}
)
.then(rc => {
process.exitCode = rc;
}).catch((e) => {
})
.catch(e => {
console.error(e);
process.exitCode = 1;
});

function optionUsageTag({short, name}: Option) {
function optionUsageTag({ short, name }: Option) {
return short !== undefined ? `-${short}, --${name}` : `--${name}`;
}

Expand Down

0 comments on commit 1e9ed49

Please sign in to comment.