eslint-config
akashic-games リポジトリで共通的に利用する eslint プリセットです。
使用側は TypeScript が必要となります。
使い方
インストール
package.json の devDependencies に下記が必要です。
npm install --save-dev @akashic/eslint-config
設定ファイルの書き方
プロジェクトのルートディレクトリに eslint.config.js を配置します。
eslint.config.js に以下のように記載します。
const eslintConfig = require("@akashic/eslint-config");
module.exports = [
...eslintConfig,
{
files: ["**/*.ts"],
languageOptions: {
sourceType: "module",
parserOptions: {
project: "tsconfig.json",
}
}
}
];
実行方法
eslint src/**/*.ts --fix
開発者向け
本ツールの publish について
- 以下の手順を踏むことで publish が行われます。
- package.json の version を更新したコミットを作成
- 1 のコミットで master ブランチを更新する
- GitHub Actions のリリースワークフローが実行される
- package-lock.json が原因で publish に失敗した場合は、
npm i --before <実行時の7日前の日付(yyyy-mm-dd)> を実行して package-lock.json を更新し、再度 publish 処理を行なってください。
ライセンス
本リポジトリは MIT License の元で公開されています。
詳しくは LICENSE をご覧ください。
ただし、画像ファイルおよび音声ファイルは
CC BY 2.1 JP の元で公開されています。
关于 @akashic/eslint-config 的常见问题
@akashic/eslint-config 是什么?
akashic-gamesリポジトリで共通的に利用するeslintのプリセットです。
如何安装 @akashic/eslint-config?
在项目目录运行 npm install @akashic/eslint-config,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@typescript-eslint/eslint-plugin(^8.21.0)、eslint(^9.18.0)、eslint-plugin-import(^2.31.0)、eslint-plugin-jest(^28.0.0)、globals(^16.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。
@akashic/eslint-config 支持 TypeScript 吗?
该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/akashic__eslint-config 是否存在。
@akashic/eslint-config 支持 ESM 还是 CommonJS?
以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。
@akashic/eslint-config 可以商用吗?
@akashic/eslint-config 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@akashic/eslint-config 的下载量有多少?
根据 npm 官方下载统计,@akashic/eslint-config 在 2026/10/06 – 2026/11/04 这 30 天内被下载 3,349 次,日均约 112 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@akashic/eslint-config 还在维护吗?
最新版本 3.1.0 发布于 2026/02/12(8 个月前);至今共发布 12 个版本,其中过去 12 个月发布了 1 个;首次发布于 2020/09/03。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。