Initial commit of coding standards for this project

djMax · djMax · commit db781b9cffdd · 2023-05-23T12:10:51.000-04:00
diff --git a/.github/workflows/npm_publish.yml b/.github/workflows/npm_publish.yml
@@ -0,0 +1,39 @@
+name: Publish npm Package
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: yarn install --immutable
+      - run: yarn build
+      - run: yarn lint
+      - run: yarn test
+
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+      - run: yarn install --immutable
+      - run: yarn build
+
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+
diff --git a/.github/workflows/pull_requests.yml b/.github/workflows/pull_requests.yml
@@ -0,0 +1,27 @@
+name: Build and run tests
+
+on:
+  pull_request:
+    types: [assigned, opened, synchronize, reopened]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+  workflow_call:
+    secrets:
+      npm_token:
+        required: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 18
+    - run: yarn install --immutable
+    - run: yarn build
+    - run: yarn lint
+    - run: yarn test
+
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,65 @@
+# Custom
+.transpiled
+.eslintcache
+
+# TypeScript incremental compilation cache
+*.tsbuildinfo
+
+# Stock
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.gz
+*.orig
+
+work
+/build
+pids
+logs
+results
+coverage
+lib-cov
+html-report
+xunit.xml
+node_modules
+npm-debug.log
+
+.project
+.idea
+.settings
+.iml
+*.sublime-workspace
+*.sublime-project
+
+.DS_Store*
+ehthumbs.db
+Icon?
+Thumbs.db
+.AppleDouble
+.LSOverride
+.Spotlight-V100
+.Trashes
+
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+.node_repl_history
+
+# TypeScript incremental compilation cache
+*.tsbuildinfo
+
+# Added by coconfig
+.eslintignore
+.npmignore
+tsconfig.json
+tsconfig.build.json
+jest.config.js
+.prettierrc.js
+.eslintrc.js
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint-staged
diff --git a/.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs b/.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
diff --git a/.yarn/releases/yarn-3.2.4.cjs b/.yarn/releases/yarn-3.2.4.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,7 @@
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+    spec: "@yarnpkg/plugin-interactive-tools"
+
+yarnPath: .yarn/releases/yarn-3.2.4.cjs
diff --git a/README.md b/README.md
@@ -0,0 +1,5 @@
+# @openapi-typescript-infra/coconfig
+
+![main CI](https://github.com/openapi-typescript-infra/coconfig/actions/workflows/npm_publish.yml/badge.svg)
+
+Default Node.js configuration files for OpenAPI Typescript projects. Uses [coconfig](/gas-buddy/coconfig) to create a pile of configuration files.
diff --git a/__tests__/index.spec.ts b/__tests__/index.spec.ts
@@ -0,0 +1,5 @@
+import { config } from '../src';
+
+test('index', () => {
+  expect(config).toBeTruthy();
+});
diff --git a/coconfig.ts b/coconfig.ts
@@ -0,0 +1,9 @@
+import { config } from './src';
+
+// During the initial creation of tsconfig. sythentic default imports are not allowed.
+// This is here so we can handle both pre and post initial creation
+const tsconfig = config['tsconfig.json'] || (config as any).default['tsconfig.json'];
+
+tsconfig.configuration.compilerOptions.target = 'ES2019';
+
+export default config;
diff --git a/package.json b/package.json
@@ -0,0 +1,52 @@
+{
+  "name": "@openapi-typescript-infra/coconfig",
+  "version": "1.0.0",
+  "description": "Default Node.js configuration files for openapi-typescript-infra projects",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "yarn dlx rimraf ./build",
+    "prepare": "husky install",
+    "lint": "eslint .",
+    "prepack": "pinst --disable",
+    "postpack": "pinst --enable",
+    "postinstall": "husky install && coconfig"
+  },
+  "engines": {
+    "node": ">12.0.0"
+  },
+  "author": "developers@pyralis.com",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/openapi-typescript-infra/coconfig.git"
+  },
+  "keywords": [
+    "typescript",
+    "openapi"
+  ],
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": "yarn eslint --cache --fix"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.1",
+    "@types/node": "^18.16.14",
+    "@typescript-eslint/eslint-plugin": "^5.59.7",
+    "@typescript-eslint/parser": "^5.59.7",
+    "coconfig": "^0.9.2",
+    "eslint": "^8.41.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "husky": "^8.0.3",
+    "jest": "^29.5.0",
+    "lint-staged": "^13.2.2",
+    "pinst": "^3.0.0",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "packageManager": "yarn@3.2.4"
+}
diff --git a/src/eslint.ts b/src/eslint.ts
@@ -0,0 +1,37 @@
+export const eslintRc = {
+  root: true,
+  extends: [
+    'eslint:recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+    'prettier',
+  ],
+  plugins: ['jest'],
+  parserOptions: {
+    project: './tsconfig.json',
+  },
+  rules: {
+    'import/prefer-default-export': [0],
+    'import/order': ['error', { 'newlines-between': 'always' }],
+    'import/no-duplicates': 'error', // Prevents multiple import statements from the same module/file
+    'import/no-default-export': 'error', // Default exports are the devil in a monorepo.
+    'no-param-reassign': [
+      2,
+      {
+        props: false,
+      },
+    ],
+    'no-var': 'error',
+    'prefer-const': 'error',
+    quotes: ['error', 'single', { avoidEscape: true }],
+  },
+  overrides: [
+    {
+      files: ['**/*.ts', '**/*.tsx'],
+      extends: ['plugin:@typescript-eslint/recommended'],
+      parser: '@typescript-eslint/parser',
+      parserOptions: { project: ['./tsconfig.json'] },
+      plugins: ['@typescript-eslint'],
+    }
+  ],
+};
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,29 @@
+import fs from 'fs';
+import path from 'path';
+
+import type { CoConfigPassthroughEntry } from 'coconfig';
+
+import { tsconfig, tsconfigBuild } from './tsconfig';
+import { jestConfig } from './jest';
+import { prettierConfig } from './prettier';
+import { eslintRc } from './eslint';
+
+interface GbCoConfig {
+  '.eslintignore': string,
+  '.npmignore': string,
+  'tsconfig.json': CoConfigPassthroughEntry<typeof tsconfig>,
+  'tsconfig.build.json': CoConfigPassthroughEntry<typeof tsconfigBuild>,
+  'jest.config.js': CoConfigPassthroughEntry,
+  '.prettierrc.js': CoConfigPassthroughEntry,
+  '.eslintrc.js': CoConfigPassthroughEntry,
+}
+
+export const config: GbCoConfig = {
+  '.eslintignore': fs.readFileSync(path.resolve(__dirname, '../templates/eslintignore'), 'utf8'),
+  '.npmignore': fs.readFileSync(path.resolve(__dirname, '../templates/npmignore'), 'utf8'),
+  'tsconfig.json': { configuration: tsconfig, stringify: true },
+  'tsconfig.build.json': { configuration: tsconfigBuild, stringify: true },
+  'jest.config.js': { configuration: jestConfig },
+  '.prettierrc.js': { configuration: prettierConfig },
+  '.eslintrc.js': { configuration: eslintRc },
+};
diff --git a/src/jest.ts b/src/jest.ts
@@ -0,0 +1,8 @@
+import type { JestConfigWithTsJest } from 'ts-jest';
+
+export const jestConfig: JestConfigWithTsJest = {
+  verbose: true,
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testRegex: '(\\.|/)(test|spec)\\.[jt]sx?$',
+};
diff --git a/src/prettier.ts b/src/prettier.ts
@@ -0,0 +1,16 @@
+export const prettierConfig = {
+  bracketSpacing: true,
+  bracketSameLine: true,
+  singleQuote: true,
+  trailingComma: 'all',
+  // A person has his limits, and 80 is not it.
+  printWidth: 100,
+  overrides: [
+    {
+      files: '*.js',
+      options: {
+        parser: 'babel',
+      },
+    },
+  ],
+};
diff --git a/src/tsconfig.ts b/src/tsconfig.ts
@@ -0,0 +1,35 @@
+export const tsconfig = {
+  include: ['@types/**/*', 'src/**/*', '__tests__/**/*', '__mocks__/**/*', 'coconfig.ts'],
+  exclude: ['node_modules', 'build'],
+  'ts-node': {
+    transpileOnly: true,
+    files: true,
+  },
+  compilerOptions: {
+    lib: ['ES2022', 'DOM'],
+    module: 'CommonJS',
+    target: 'ES2022',
+    declaration: true,
+    sourceMap: true,
+    outDir: './build',
+    incremental: true,
+    isolatedModules: true,
+    strict: true,
+    moduleResolution: 'NodeNext',
+    baseUrl: './src',
+    allowSyntheticDefaultImports: true,
+    esModuleInterop: true,
+    experimentalDecorators: true,
+  },
+};
+
+export const tsconfigBuild = {
+  extends: './tsconfig.json',
+  exclude: [
+    'src/**/*.spec.ts',
+    'src/**/*.test.ts',
+    '__tests__/**/*.ts',
+    '__mocks__/**/*.ts',
+    'coconfig.ts',
+  ],
+};
diff --git a/templates/eslintignore b/templates/eslintignore
@@ -0,0 +1,7 @@
+build/
+coverage
+jest.config.js
+.eslintrc.js
+coconfig.?s
+src/generated
+node_modules
diff --git a/templates/npmignore b/templates/npmignore
diff --git a/yarn.lock b/yarn.lock
