rollup.js × TypeScriptのライブラリをnpm公開する環境の構築(2020年12月版)

公開:2020/10/18
更新:2020/12/31
15 min読了の目安(約13700字TECH技術記事

rollup.js と TypeScript を使ってnpm公開用のライブラリを作ろうとしたら、
Rollupの公式プラグインがRollup Pluginsに移動していて、
ビルド環境構築に苦労したので、雑にメモを残しておきます。

作るもの ✍

  • npmで公開するためのライブラリを作成する環境
    • モジュールバンドラにrollup.jsを利用する
    • TypeScriptを使って開発する
    • 他のnpmのモジュール(CommonJSも含む)も利用できる
  • 作成したライブラリは、汎用的に使えるようにする
    • CommonJS、ESModuleで利用できる
    • CDN経由でブラウザで利用できる
      (bubleでトランスパイルし、IEでも動くように😇)
    • babelを利用してES2015まで構文変換は行うが、pollifillは利用者側に委ねる
      • ライブラリが個々にpollifillを内包することで、容量の肥大化することを懸念。
      • ブラウザで利用したい場合は、Polyfill.ioを利用すれば容易に導入できる。

前提 🤓

  • NodeJSがインストール済みであること
  • npmで公開するための下準備(アカウント作成、ログイン)が終わっていること
  • linterやformatter、testについては省略

ディレクトリ構成 📂

projectRoot/
 ├ .github/                  ・・・ github関連設定ファイル格納ディレクトリ
 │ └ workflows/             ・・・ github actions関連設定ファイル格納ディレクトリ
 │  └ publish-to-npm.yaml  ・・・ リリース用のAction設定ファイル
 ├ dist/                     ・・・ ビルドしたファイルが出力される場所(Gitにはコミットしない)
 ├ src/                      ・・・ ソースファイル格納ディレクトリ
 │ ├ index.ts               ・・・ エントリポイント(ブラウザ、CommonJS向け)
 │ └ library-name.ts        ・・・ エントリポイント(ESModules向け)
 ├ types/                   ・・・ TypeScriptの型ファイルを格納する
 │ └ index.d.ts             ・・・ TypeScriptの型ファイル
 ├ .babelrc.js              ・・・ babel用設定ファイル
 ├ .browserslistrc          ・・・ browserslistrc用設定ファイル(ターゲットのブラウザを指定する)
 ├ LICENSE                  ・・・ ライセンス(Githubとかのリポジトリ作成時にできるので十分)
 ├ package.json             ・・・ npm用の設定ファイル(詳細は後述)
 ├ README.md                ・・・ ライブラリの説明等
 ├ rollup.config.js         ・・・ rollup用のビルド設定ファイル(詳細は後述)
 └ tsconfig.json            ・・・ TypeScriptの設定ファイル(詳細は後述)

設定ファイル ⛏

長いですが、コメントをいれつつ、全て記載します。

/packagie.json
{
  // Scoped Packagesにするため、先頭に@username/を付けておく
  "name": "@ohnaka0410/library-name",
  // ひとまず最小バージョンから始める
  "version": "0.0.1",
  // いい感じの説明を書く
  "description": "library description",
  // (ビルドしたファイルが出力される)distディレクトリはgitにはコミットしない
  // commonJS用のエントリポイント
  "main": "dist/index.js",
  // TypeScriptの型定義
  "types": "types/index.d.ts",
  // ES Modules用のエントリポイント
  "module": "dist/index.es.js",
  // ブラウザ用のエントリポイント
  "browser": "dist/library-name.js",
  // npmに公開するファイル
  // この他にLICENCEやREADME.mdは含まれるよになっている
  "files": [
    "package.json",
    "README.md",
    "LICENSE",
    "types",
    "dist"
  ],
  // npm用のキーワード
  "keywords": [
    "front-end",
    "vanillajs",
    "typescript"
  ],
  // 製作者
  "author": "ohnaka0410",
  // ライセンス(特にこだわりがなければMITでよい)
  "license": "MIT",
  // npm runで実行するスクリプト
  "scripts": {
    // ビルド前処理
    "prebuild": "rimraf dist",
    // ビルド処理
    "build": "rollup -c"
  },
  // npmのRepositoryに記載される
  "repository": {
    "type": "git",
    "url": "git+https://ohnaka0410@github.com/ohnaka0410/library-name.git"
  },
  // npmのIssuesに記載される
  "bugs": {
    "url": "https://github.com/ohnaka0410/library-name/issues"
  },
  // npmのHomepageに記載される
  "homepage": "https://github.com/ohnaka0410/library-name#readme",
  // 公開パッケージに含めるモジュール
  "dependencies": {
    "tslib": "^2.0.3"
  },
  // 開発時に利用するモジュール
  "devDependencies": {
    "@babel/core": "^7.12.10",
    "@babel/preset-env": "^7.12.11",
    "@rollup/plugin-babel": "^5.2.2",
    "@rollup/plugin-commonjs": "^17.0.0",
    "@rollup/plugin-node-resolve": "^11.0.1",
    "@rollup/plugin-typescript": "^8.1.0",
    "lodash.camelcase": "^4.3.0",
    "lodash.upperfirst": "^4.3.1",
    "rimraf": "^3.0.2",
    "rollup": "^2.35.1",
    "rollup-plugin-terser": "^7.0.2",
    "typescript": "^4.1.3"
  }
}
/rollup.config.js
// 各種プラグインを読み込む
import pluginNodeResolve from "@rollup/plugin-node-resolve";
import pluginCommonjs from "@rollup/plugin-commonjs";
import pluginTypescript from "@rollup/plugin-typescript";
import { babel as pluginBabel } from "@rollup/plugin-babel";
import { terser as pluginTerser } from "rollup-plugin-terser";

import * as path from "path";

import camelCase from "lodash.camelcase";
import upperFirst from "lodash.upperfirst";

import pkg from "./package.json";

// Scopeを除去する
const moduleName = upperFirst(camelCase(pkg.name.replace(/^\@.*\//, '')));

// ライブラリに埋め込むcopyright
const banner = `/*!
  ${moduleName}.js v${pkg.version}
  ${pkg.homepage}
  Released under the ${pkg.license} License.
*/`;

export default [
  // ブラウザ用設定
  {
    // エントリポイント
    input: 'src/index.ts',
    output: [
      // minifyせずに出力する
      {
        // exportされたモジュールを格納する変数
        name: moduleName,
        // 出力先ファイル
        file: pkg.browser,
        // ブラウザ用フォーマット
        format: 'iife',
        // ソースマップをインラインで出力
        sourcemap: 'inline',
        // copyright
        banner,
      },
      // minifyして出力する
      {
        name: moduleName,
        // minifyするので.minを付与する
        file: pkg.browser.replace('.js', '.min.js'),
        format: 'iife',
        banner,
        // minify用プラグインを追加で実行する
        plugins: [
          terser(),
        ],
      },
    ],
    plugins: [
      pluginTypescript(),
      pluginCommonjs({
        extensions: [".js", ".ts"],
      }),
      pluginBabel({
        babelHelpers: "bundled",
        configFile: path.resolve(__dirname, ".babelrc.js"),
      }),
      pluginNodeResolve({
        browser: true,
      }),
    ],
  },
  // ESモジュール用設定
  {
    input: `src/${pkg.name.replace(/^\@.*\//, "")}.ts`,
    output: [
      {
        file: pkg.module,
        format: "es",
        sourcemap: "inline",
        banner,
        exports: "named",
      },
    ],
    // 他モジュールは含めない
    external: [
      ...Object.keys(pkg.dependencies || {}),
      ...Object.keys(pkg.devDependencies || {}),
    ],
    plugins: [
      pluginTypescript(),
      pluginBabel({
        babelHelpers: "bundled",
        configFile: path.resolve(__dirname, ".babelrc.js"),
      }),
    ],
  },
  // CommonJS用設定
  {
    input: "src/index.ts",
    output: [
      {
        file: pkg.main,
        format: "cjs",
        sourcemap: "inline",
        banner,
        exports: "default",
      },
    ],
    // 他モジュールは含めない
    external: [
      ...Object.keys(pkg.dependencies || {}),
      ...Object.keys(pkg.devDependencies || {}),
    ],
    plugins: [
      pluginTypescript(),
      pluginBabel({
        babelHelpers: "bundled",
        configFile: path.resolve(__dirname, ".babelrc.js"),
      }),
    ],
  },
];
/tsconfig.json
{
  "compilerOptions": {
    /* Basic Options */
    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */,
    "module": "esnext" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    "allowJs": true /* Allow javascript files to be compiled. */,
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    // "outDir": "./",                        /* Redirect output structure to the directory. */
    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "removeComments": true,                /* Do not emit comments to output. */
    "noEmit": true /* Do not emit outputs. */,
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    "isolatedModules": true /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */,

    /* Strict Type-Checking Options */
    "strict": true /* Enable all strict type-checking options. */,
    "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
    "strictNullChecks": true /* Enable strict null checks. */,
    "strictFunctionTypes": true /* Enable strict checking of function types. */,
    "strictBindCallApply": true /* Enable strict 'bind', 'call', and 'apply' methods on functions. */,
    "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */,
    "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */,
    "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */,

    /* Additional Checks */
    "noUnusedLocals": true /* Report errors on unused locals. */,
    "noUnusedParameters": true /* Report errors on unused parameters. */,
    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
    "noUncheckedIndexedAccess": true /* Include 'undefined' in index signature results */,

    /* Module Resolution Options */
    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    "baseUrl": "./" /* Base directory to resolve non-absolute module names. */,
    "paths": {
      "@/*": ["src/*"]
    } /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */,
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    "skipLibCheck": true /* Skip type checking of declaration files. */,
    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */,

    "resolveJsonModule": true
  },
  "include": ["src/**/*.ts", "types/**/*.d.ts"],
  "exclude": ["node_modules"]
}
/.babelrc.js
/**
 * Babel Configuration
 */
module.exports = {
  presets: [
    [
      "@babel/preset-env",
      // {
      //   useBuiltIns: "usage",
      //   corejs: 3,
      // },
    ],
  ],
};

/.github/workflows/publish-to-npm.yaml
name: Publish To npm
# mainブランチにPushされた場合に実行する
on:
  push:
    branches:
      - main
    tags:
      - "!*"
  workflow_dispatch:
jobs:
  publish-to-npm:
    runs-on: ubuntu-latest
    steps:
      # リポジトリのsecrets.NODE_AUTH_TOKENに、npmで発行したTokenを登録しておく。
      - name: Checkout
        uses: actions/checkout@v2
      - name: Use Node.js And Setup .npmrc
        uses: actions/setup-node@v1
        with:
          node-version: '14.x'
          registry-url: 'https://registry.npmjs.org'
          # ↓ package.json の name に含めたスコープを指定しておく
          scope       : '@ohnaka0410'
          always-auth : true
        env :
          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
      # リリース可能か確認
      - name: Can Publish
        run : npx can-npm-publish --verbose
        env :
          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
      - name: Install
        run : npm install
        env :
          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
      - name: Build
        run : npm run build --if-present
        env :
          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
      # リリース
      - name: Publish
        run : npm publish --access=public
        env :
          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
      # Gitでリリースタグを作成
      - name: package-version-to-git-tag
        uses: pkgdeps/action-package-version-to-git-tag@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          github_repo: ${{ github.repository }}
          git_commit_sha: ${{ github.sha }}
          git_tag_prefix: "v"

まとめ? 🤔

とりあえず手探りで作ってみたので、おかしなところがあれば修正していきます😇

ためしに以下で導入してみました↓
ohnaka0410/minimal-modal
ohnaka0410/minimal-collapse