heft コマンド

npm install --global pnpm

{
  "name": "my-app",
  "version": "1.0.0",
  "description": "A Heft tutorial project",
  "license": "MIT",
  "main": "lib/start.js",
  "typings": "lib/start.d.ts",
  "scripts": {
    "start": "node lib/start.js"
  }
}

console.log("Hello, world!");

pnpm install --save-dev @rushstack/heft
pnpm install --save-dev typescript
# 型定義のインストールは --save-exact オプションを常に付けるように
pnpm install --save-dev --save-exact @types/node

{
  "$schema": "http://json.schemastore.org/tsconfig",

  "compilerOptions": {
    "outDir": "lib",
    "rootDirs": ["src/"],

    "forceConsistentCasingInFileNames": true,
    "declaration": true,
    "sourceMap": true,
    "declarationMap": true,
    "inlineSources": true,
    "experimentalDecorators": true,
    "strict": true,
    "esModuleInterop": true,
    "types": ["node"],

    "module": "commonjs",
    "target": "es2017",
    "lib": ["es2017"]
  },
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules", "lib"]
}

pnpm install --global @rushstack/heft

heft build

pnpm run start

# rush が導入済みなら
rushx start
# も OK
# だけどこのチュートリアルでは未導入のはずなので覚えておくだけ

{
  . . .
  "scripts": {
    "build": "heft build --clean",
    "start": "node lib/start.js"
  },
  . . .
}

/**
 * Defines configuration used by core Heft.
 */
{
  "$schema": "https://developer.microsoft.com/json-schemas/heft/heft.schema.json",

  "eventActions": [
    {
      /**
       * The kind of built-in operation that should be performed.
       * The "deleteGlobs" action deletes files or folders that match the
       * specified glob patterns.
       */
      "actionKind": "deleteGlobs",

      /**
       * The stage of the Heft run during which this action should occur. Note that actions specified in heft.json
       * occur at the end of the stage of the Heft run.
       */
      "heftEvent": "clean",

      /**
       * A user-defined tag whose purpose is to allow configs to replace/delete handlers that were added by other
       * configs.
       */
      "actionId": "defaultClean",

      /**
       * Glob patterns to be deleted. The paths are resolved relative to the project folder.
       */
      "globsToDelete": ["dist", "lib", "temp"]
    }
  ],

  /**
   * The list of Heft plugins to be loaded.
   */
  "heftPlugins": [
    // {
    //  /**
    //   * The path to the plugin package.
    //   */
    //  "plugin": "path/to/my-plugin",
    //
    //  /**
    //   * An optional object that provides additional settings that may be defined by the plugin.
    //   */
    //  // "options": { }
    // }
  ]
}

{
    . . .
    "files.associations": {
        "*.json": "jsonc"
    },
    . . .
}

# 型定義のときは --save-exact オプション付き
pnpm install --save-dev --save-exact @types/heft-jest

{
    . . .
    "types": ["heft-jest", "node"],
    . . .
}

{
  "preset": "./node_modules/@rushstack/heft/includes/jest-shared.config.json"
}

describe('Example Test', () => {
  it('correctly runs a test', () => {
    expect(true).toBeTruthy();
  });
});

heft test

{
  . . .
  "scripts": {
    "build": "heft test --clean", // --clean オプション ビルド成果を破棄して新規ビルド
    "start": "node lib/start.js"
  },
  . . .
}

pnpm install --save-dev eslint
pnpm install --save-dev @rushstack/eslint-config

// This is a workaround for https://github.com/eslint/eslint/issues/3458
require('@rushstack/eslint-config/patch/modern-module-resolution');

module.exports = {
  extends: ['@rushstack/eslint-config/profile/node'],
  parserOptions: { tsconfigRootDir: __dirname }
};

console.log('Hello, world!');

export function f() {
  // <--- あらら
}

. . .
---- Compile started ----
[copy-static-assets] Copied 0 static assets in 0ms
[typescript] Using TypeScript version 3.9.7
[eslint] Using ESLint version 7.5.0
[eslint] Encountered 1 ESLint error:
[eslint]   ERROR: src\start.ts:3:8 - (@typescript-eslint/explicit-function-return-type) Missing return type on function.
. . .

console.log('Hello, world!');

export function f(): void {
  // <--- 勝ったなこれ
}