breaking: change default verbs + cleanup (#43)

* Replace `lint` with `check` which checks both format and lint errors.
* Remove unnecessary `build` script.
* Add prepare, pretest and posttest scripts to target.
* Terminate with proper exit code on failures
* Get rid of trivial fix.ts
* README improvements.

Fixes: #35

Author: ofrobots

README.md

@@ -21,13 +21,18 @@ Still on an older version of npm? We got ya! In a directory with your `package.j
 
 ```sh
 npm install --save-dev google-ts-style [email protected] [email protected] [email protected]
-$(npm bin)/gts init
+$(npm bin)/google-ts-style init
 ```
 
 # How this works
-- Adds a `tsconfig.json` file to your project that inherits from the Google TS Style.
-- Adds the necessary devDependencies to your package.json.
-- Adds the `compile`, `format`, and `lint` scripts to your package.json.
+- Adds a `tsconfig.json` file to your project that uses the Google TS Style.
+- Adds the necessary devDependencies to your `package.json`.
+- Adds scripts to your `package.json`:
+  - `check`: Lints and checks for formatting problems.
+  - `fix`: Automatically fixes formatting and linting problems (if possible).
+  - `clean`: Removes output files.
+  - `compile`: Compiles the source code using TypeScript compiler.
+  - `pretest`, `posttest` and `prepare`: convenience integrations.
 
 # License
 See [LICENSE.md](LICENSE.md)

src/clean.ts

@@ -21,23 +21,25 @@ import {getTSConfig, rimrafp} from './util';
 /**
  * Remove files generated by the build.
  */
-export async function clean(options: Options): Promise<void> {
+export async function clean(options: Options): Promise<boolean> {
   const tsconfig = (await getTSConfig(options.targetRootDir));
   if (tsconfig.compilerOptions && tsconfig.compilerOptions.outDir) {
     const outDir = tsconfig.compilerOptions.outDir;
     if (outDir === '.') {
       console.error(
           `${chalk.red('ERROR:')} ${chalk.gray('compilerOptions.outDir')} ` +
           `cannot use the value '.'.  That would delete all of our sources.`);
-      return;
+      return false;
     }
     const message = `${chalk.red('Removing')} ${outDir} ...`;
     console.log(message);
     await rimrafp(outDir);
+    return true;
   } else {
     console.error(
         `${chalk.red('ERROR:')} The ${chalk.gray('clean')} command` +
         ` requires ${chalk.gray('compilerOptions.outDir')} to be defined in ` +
         `tsconfig.json.`);
+    return false;
   }
 }

src/cli.ts

@@ -18,7 +18,7 @@ import * as meow from 'meow';
 import * as updateNotifier from 'update-notifier';
 import {init} from './init';
 import {lint} from './lint';
-import {fix} from './fix';
+import {format} from './format';
 import {clean} from './clean';
 
 export interface Options {
@@ -34,8 +34,8 @@ const cli = meow(`
 
     Verb can be:
       init        Adds default npm scripts to your package.json.
-      lint        Runs the lint tool against all *.ts files in the cwd.
-      fix         Runs the tslint and clang fix tools for all *.ts files.
+      check       Checks code for formatting and lint issues.
+      fix         Fixes formatting and linting issues (if possible).
       clean       Removes all files generated by the build.
 
   Options
@@ -44,7 +44,7 @@ const cli = meow(`
     --dry-run     Don't make any acutal changes.
 
 	Examples
-    $ gts init
+    $ gts init -y
     $ gts lint
     $ gts fix
     $ gts clean
@@ -57,34 +57,36 @@ function usage(msg?: string): void {
   cli.showHelp(1);
 }
 
+async function run(verb: string): Promise<boolean> {
+  const options: Options = {
+    dryRun: cli.flags.dryRun || false,
+    gtsRootDir: `${process.cwd()}/node_modules/google-ts-style`,
+    targetRootDir: process.cwd(),
+    yes: cli.flags.yes || cli.flags.y || false
+  };
+  switch (verb) {
+    case 'init':
+      return await init(options);
+    case 'check':
+      return (await lint(options) && await format(options));
+    case 'fix':
+      return (await lint(options, true) && await format(options, true));
+    case 'clean':
+      return await clean(options);
+    default:
+      usage(`Unknown verb: ${verb}`);
+      return false;
+  }
+}
+
 updateNotifier({pkg: cli.pkg}).notify();
 
 if (cli.input.length !== 1) {
   usage();
 }
 
-const verb = cli.input[0];
-const options: Options = {
-  dryRun: cli.flags.dryRun || false,
-  gtsRootDir: `${process.cwd()}/node_modules/google-ts-style`,
-  targetRootDir: process.cwd(),
-  yes: cli.flags.yes || cli.flags.y || false
-};
-
-switch (verb) {
-  case 'init':
-    init(options);
-    break;
-  case 'lint':
-    lint(options);
-    break;
-  case 'fix':
-    fix(options);
-    break;
-  case 'clean':
-    clean(options);
-    break;
-  default:
-    usage(`Unknown verb: ${verb}`);
-    break;
-}
+run(cli.input[0]).then(success => {
+  if (!success) {
+    process.exit(1);
+  }
+});

src/fix.ts

@@ -23,10 +23,10 @@ const baseArgs =
 
 /**
  * Run tslint fix and clang fix with the default configuration
- * @param fix whether to automatically fix the format
  * @param options
+ * @param fix whether to automatically fix the format
  */
-export function format(fix: boolean, options: Options): Promise<boolean> {
+export function format(options: Options, fix = false): Promise<boolean> {
   const program = createProgram(options);
   const srcFiles = program.getSourceFiles()
                        .map(sourceFile => sourceFile.fileName)

src/format.ts

@@ -49,11 +49,13 @@ async function addScripts(
     packageJson: any, options: Options): Promise<boolean> {
   let edits = false;
   const scripts: Bag<string> = {
-    build: 'npm run compile',
+    check: `gts check`,
     clean: 'gts clean',
     compile: `tsc -p .`,
     fix: `gts fix`,
-    lint: `gts lint`
+    prepare: `npm run compile`,
+    pretest: `npm run compile`,
+    posttest: `npm run check`
   };
 
   if (!packageJson.scripts) {
@@ -180,7 +182,7 @@ async function generateTsConfig(options: Options): Promise<void> {
   }
 }
 
-export async function init(options: Options): Promise<void> {
+export async function init(options: Options): Promise<boolean> {
   let packageJson;
   try {
     packageJson = await readJson('./package.json', noop, true /*strict*/);
@@ -194,7 +196,7 @@ export async function init(options: Options): Promise<void> {
 
     if (!generate) {
       console.log('Please run from a directory with your package.json.');
-      return;
+      return false;
     }
 
     try {
@@ -214,4 +216,5 @@ export async function init(options: Options): Promise<void> {
     console.log('No edits needed in package.json.');
   }
   await generateTsConfig(options);
+  return true;
 }