chore: typescript + lint setup

.commitlintrc

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@commitlint/config-conventional"
+  ]
+}

.czrc

@@ -0,0 +1,3 @@
+{
+  "path": "cz-conventional-changelog"
+}

.eslintrc.cjs

@@ -0,0 +1,47 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: './tsconfig.json',
+    tsconfigRootDir: __dirname,
+    ecmaVersion: 10,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:jest/recommended",
+    "airbnb-base",
+    "airbnb-typescript/base",
+    "prettier"
+  ],
+  plugins: [
+    '@typescript-eslint',
+    'eslint-plugin-tsdoc',
+    'jest'
+  ],
+  env: {
+    es2021: true,
+    browser: true,
+    node: true,
+  },
+  rules: {
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    'import/prefer-default-export': 'off',
+    'no-console': ["error", { allow: ["warn", "info", "error"] }],
+    'no-underscore-dangle': 'off',
+    'no-shadow': 'off',
+    'no-plusplus': 'off',
+    'tsdoc/syntax': 'warn',
+    'arrow-body-style': 'off',
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        selector: ['variable', 'function'],
+        format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
+        trailingUnderscore: 'allow',
+      },
+    ],
+  },
+};

.gitignore

@@ -303,7 +303,6 @@ dist
 
 # yarn v2
 .yarn/*
-!.yarn/cache
 !.yarn/patches
 !.yarn/plugins
 !.yarn/releases

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commit-lint --edit $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn run lint-staged

.lintstagedrc

@@ -0,0 +1,9 @@
+{
+  "**/*.{ts,tsx,js,jsx}": [
+    "eslint --quiet --fix",
+    "prettier --write"
+  ],
+  "**/*.{md,yml,json,babelrc,eslintrc,prettierrc}": [
+    "prettier --write"
+  ]
+}

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "bracketSpacing": true,
+  "printWidth": 100,
+  "proseWrap": "always",
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all"
+}

package.json

@@ -2,9 +2,7 @@
   "name": "japanese-moji",
   "version": "1.0.0",
   "description": "A toolkit to validate Japanese characters",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
+  "type": "module",
   "packageManager": "yarn@3.1.1",
   "repository": {
     "type": "git",
@@ -33,5 +31,41 @@
   "bugs": {
     "url": "https://github.com/arjunvegda/japanese-moji/issues"
   },
-  "homepage": "https://github.com/arjunvegda/japanese-moji#readme"
+  "homepage": "https://github.com/arjunvegda/japanese-moji#readme",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "lint-staged": "lint-staged",
+    "commit-lint": "commitlint"
+  },
+  "engines": {
+    "node": "^14.13.1 || >=16.0.0",
+    "yarn": ">=3"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^16.1.0",
+    "@commitlint/config-conventional": "^16.0.0",
+    "@types/jest": "^27.4.0",
+    "@types/node": "^17.0.15",
+    "@typescript-eslint/eslint-plugin": "^5.10.2",
+    "@typescript-eslint/parser": "^5.10.2",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.8.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^16.1.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^26.0.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-tsdoc": "^0.2.14",
+    "husky": "^7.0.4",
+    "jest": "^27.5.0",
+    "lint-staged": "^12.3.3",
+    "prettier": "^2.5.1",
+    "ts-node": "^10.4.0",
+    "tslib": "^2.3.1",
+    "typescript": "^4.5.5"
+  }
 }

src/index.ts

@@ -0,0 +1,3 @@
+export const sayHello = () => {
+  console.info(`Hello`);
+};

tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "incremental": true,
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["es2017", "es2020"],
+    "strict": true,
+    "importsNotUsedAsValues": "error",
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": true,
+    "declaration": true,
+    "declarationDir": "build",
+    "sourceMap": true,
+    "importHelpers": true,
+    "resolveJsonModule": true,
+    "baseUrl": "./src",
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "typeRoots": ["node_modules/@types/", "@types"],
+    "rootDir": "./src",
+    "outDir": "build",
+    "noEmit": true
+  },
+  "include": ["./src/**/*", "__tests__/**/*"],
+  "exclude": ["node_modules"]
+}