Initial Fork Release

.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: Pull Request Linting
+on:
+ pull_request:
+ branches: [main]
+
+permissions:
+ contents: read
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v2
+ - name: Setup Node.js
+ uses: actions/setup-node@v3
+ with:
+ node-version: 'lts/*'
+ - name: Install dependencies
+ run: npm clean-install
+ - name: Run linters
+ run: npm run lint

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Automated NPM Release
+on:
+ push:
+ branches: [main]
+
+permissions:
+ contents: read
+
+jobs:
+ release:
+ name: Release
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write # to be able to publish a GitHub release
+ issues: write # to be able to comment on released issues
+ pull-requests: write # to be able to comment on released pull requests
+ id-token: write # to enable use of OIDC for npm provenance
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+ - name: Setup Node.js
+ uses: actions/setup-node@v3
+ with:
+ node-version: 'lts/*'
+ - name: Install dependencies
+ run: npm clean-install
+ - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+ run: npm audit signatures
+ - name: Release
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+ run: npx semantic-release

.gitignore

@@ -1,2 +1 @@
-/.eslintcache
-/node_modules
+node_modules

.husky/commit-msg

@@ -0,0 +1 @@
+commitlint --edit ${1}

.husky/pre-push

@@ -0,0 +1 @@
+npm run lint

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Contributing
+
+## Commit Messages
+
+Please use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) with the [conventional changelog types](https:/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum). These allow us to follow [Semantic Versioning](https://semver.org/) in our [automated release pipeline](https://semantic-release.gitbook.io/semantic-release).
+
+You may be asked to rebase your branch if the commit messages need to be fixed (and cannot be addressed with a simple squash merge).
+
+## Pull Request Guidelines
+
+1. A pull request should, ideally, focus on a single improvement or fix. If you have many changes or improvements, consider breaking your work apart and submitting as multiple PRs.
+2. If your branch has many commits, please consider rebasing _before_ submitting the pull request. Once a pull request has been made and a reviewer assigned, please _do not_ rebase or rewrite your branch history unless asked.
+ - Your changes may be squashed on merge to keep the changelog clean.
+3. Please give maintainers / reviewers up to 2 weeks to reply. After that, feel free to bump!
+
+## Third-Party Types
+
+Because the upstream [Airbnb eslint config project](https:/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base) provides no type declarations, we've needed to add our own for Typescript to pass validation. These can be found under `types/third-party/eslint-config-airbnb-base/`.
+
+Because the upstream project is rarely updated and this is a temporary solution, these were manually generated by having `tsc` generate declarations from the [rules files](https:/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/) with one modification to add a trailing [`as const`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#const-assertions-and-default-type-arguments-in-jsdoc) on the exported object literals. If we need to update these in the future, it's likely we should actually contribute to the upstream or make a submission to the [DefinitelyTyped](https:/DefinitelyTyped/DefinitelyTyped).

README.md

@@ -1,11 +1,12 @@
-# eslint-config-airbnb-typescript
+# Typescript Compatible Airbnb Rules for ESLint
 
-[![Version](https://img.shields.io/npm/v/eslint-config-airbnb-typescript.svg?style=flat-square)](https://www.npmjs.com/package/eslint-config-airbnb-typescript?activeTab=versions) [![Downloads](https://img.shields.io/npm/dt/eslint-config-airbnb-typescript.svg?style=flat-square)](https://www.npmjs.com/package/eslint-config-airbnb-typescript) [![Last commit](https://img.shields.io/github/last-commit/iamturns/eslint-config-airbnb-typescript.svg?style=flat-square)](https:/iamturns/eslint-config-airbnb-typescript/graphs/commit-activity) [![Build](https://img.shields.io/circleci/project/github/iamturns/eslint-config-airbnb-typescript/master.svg?style=flat-square)](https://circleci.com/gh/iamturns/eslint-config-airbnb-typescript) [![License](https://img.shields.io/github/license/iamturns/eslint-config-airbnb-typescript.svg?style=flat-square)](https:/iamturns/eslint-config-airbnb-typescript/blob/master/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https:/iamturns/eslint-config-airbnb-typescript/blob/master/CONTRIBUTING.md) [![Code of conduct](https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square)](https:/iamturns/eslint-config-airbnb-typescript/blob/master/CODE_OF_CONDUCT.md)
+[![Version](https://img.shields.io/npm/v/@kesills/eslint-config-airbnb-typescript.svg?style=flat-square)](https://www.npmjs.com/package/@kesills/eslint-config-airbnb-typescript?activeTab=versions) [![Downloads](https://img.shields.io/npm/dm/@kesills/eslint-config-airbnb-typescript.svg?style=flat-square)](https://www.npmjs.com/package/@kesills/eslint-config-airbnb-typescript)
 
 Enhances [Airbnb's ESLint config](https://www.npmjs.com/package/eslint-config-airbnb) with TypeScript support.
+Forked from the generous work of [Matt Turnbull](https:/iamturns/eslint-config-airbnb-typescript)!
 
 > [!WARNING]
-> We currently **do not** support ESLint v9 or above. Please see issue #331 to track progress.
+> We currently **do not** support ESLint v9 or above. Please see issue #15 to track progress.
 
 ## Setup
 
@@ -14,7 +15,7 @@ Enhances [Airbnb's ESLint config](https://www.npmjs.com/package/eslint-config-ai
 Start by installing both ESLint and Typescript in your project. Afterwards, you can install this config through your favorite package manager normally:
 
 ```sh
-npm install -D eslint-config-airbnb-typescript
+npm install -D @kesills/eslint-config-airbnb-typescript
 ```
 
 If you're using React, you'll also need to install the appropriate Airbnb rules separately:
@@ -44,7 +45,7 @@ Next, tell ESLint to extend from this configuration. And since we need to access
 
 #### Recommended - Flat Config
 
-Since we don't yet have first-class support for the new flat configuration format (see #307 for progress), [ESLint's compatability utility](https://www.npmjs.com/package/@eslint/eslintrc) is needed:
+Since we don't yet have first-class support for the new flat configuration format (see #14 for progress), [ESLint's compatability utility](https://www.npmjs.com/package/@eslint/eslintrc) is needed:
 
 ```sh
 npm install -D @eslint/eslintrc
@@ -62,11 +63,11 @@ const compat = new FlatCompat({
 export default [
  // Without React
  ...compat.extends('airbnb-base'),
- ...compat.extends('airbnb-typescript/base'),
+ ...compat.extends('@kesills/airbnb-typescript/base'),
 
  // With React
  ...compat.extends('airbnb'),
- ...compat.extends('airbnb-typescript'),
+ ...compat.extends('@kesills/airbnb-typescript'),
 
  // Either way
  {
@@ -89,11 +90,11 @@ module.exports = {
  extends: [
  // Without React
  'airbnb-base',
- 'airbnb-typescript/base'
+ '@kesills/airbnb-typescript/base'
 
  // With React
  'airbnb',
- 'airbnb-typescript'
+ '@kesills/airbnb-typescript'
  ],
  parserOptions: {
  projectService: true,
@@ -133,7 +134,7 @@ import typescriptPlugin from 'typescript-eslint';
 export default [
  ...compat.extends('airbnb-base'),
  ...compat.extends('airbnb/hooks'),
- ...compat.extends('airbnb-typescript/base'),
+ ...compat.extends('@kesills/airbnb-typescript/base'),
  ...typescriptPlugin.configs.recommendedTypeChecked,
  ...typescriptPlugin.configs.stylisticTypeChecked,
  {
@@ -196,10 +197,10 @@ If you would like to enable this rule, then:
 
 ## Credits
 
-Authored and maintained by Matt Turnbull ([iamturns.com](https://iamturns.com) / [@iamturns](https://twitter.com/iamturns))
+Originally authored by Matt Turnbull. Forked and maintained by Kenneth Sills.
 
-A big thank you to all [contributors](https:/iamturns/eslint-config-airbnb-typescript/graphs/contributors)!
+A big thank you to all [contributors](https:/Kenneth-Sills/eslint-config-airbnb-typescript/graphs/contributors)!
 
 ## License
 
-Open source [licensed as MIT](https:/iamturns/eslint-config-airbnb-typescript/blob/master/LICENSE).
+Open source [licensed as MIT](./LICENSE).

base.js

@@ -1,3 +1,3 @@
 module.exports = {
- extends: ['./lib/shared.js'].map(require.resolve),
+ extends: ['./lib/shared.js'].map((path) => require.resolve(path)),
 };

index.js

@@ -1,6 +1,6 @@
 // This file adds some React specific settings. Not using React? Use base.js instead.
 module.exports = {
- extends: ['./lib/shared'].map(require.resolve),
+ extends: ['./lib/shared'].map((path) => require.resolve(path)),
  settings: {
  // Append 'ts' extensions to Airbnb 'import/resolver' setting
  // Prepend 'mjs' to match shared config

lib/shared.js

@@ -1,11 +1,9 @@
-/* eslint-disable import/no-extraneous-dependencies */
 const { rules: baseBestPracticesRules } = require('eslint-config-airbnb-base/rules/best-practices');
 const { rules: baseErrorsRules } = require('eslint-config-airbnb-base/rules/errors');
 const { rules: baseES6Rules } = require('eslint-config-airbnb-base/rules/es6');
 const { rules: baseImportsRules } = require('eslint-config-airbnb-base/rules/imports');
 const { rules: baseStyleRules } = require('eslint-config-airbnb-base/rules/style');
 const { rules: baseVariablesRules } = require('eslint-config-airbnb-base/rules/variables');
-/* eslint-enable import/no-extraneous-dependencies */
 
 module.exports = {
  plugins: ['@typescript-eslint', '@stylistic'],
@@ -15,16 +13,19 @@ module.exports = {
  'import/parsers': {
  '@typescript-eslint/parser': ['.ts', '.tsx', '.d.ts'],
  },
+
  // Append 'ts' extensions to Airbnb 'import/resolver' setting
  // Original: ['.mjs', '.js', '.json']
  'import/resolver': {
  node: {
  extensions: ['.mjs', '.js', '.json', '.ts', '.d.ts'],
  },
  },
+
  // Append 'ts' extensions to Airbnb 'import/extensions' setting
  // Original: ['.js', '.mjs', '.jsx']
  'import/extensions': ['.js', '.mjs', '.jsx', '.ts', '.tsx', '.d.ts'],
+
  // Resolve type definition packages
  'import/external-module-folders': ['node_modules', 'node_modules/@types'],
  },
@@ -181,14 +182,23 @@ module.exports = {
  ...baseImportsRules['import/no-extraneous-dependencies'][1],
  devDependencies: baseImportsRules[
  'import/no-extraneous-dependencies'
- ][1].devDependencies.reduce((result, devDep) => {
- const toAppend = [devDep];
- const devDepWithTs = devDep.replace(/\bjs(x?)\b/g, 'ts$1');
- if (devDepWithTs !== devDep) {
- toAppend.push(devDepWithTs);
- }
- return [...result, ...toAppend];
- }, []),
+ ][1].devDependencies.reduce(
+ /**
+ * @param {string[]} result
+ * @param {string} devDep
+ */
+ (result, devDep) => {
+ const toAppend = [devDep];
+ const devDepWithTs = devDep.replace(/\bjs(x?)\b/g, 'ts$1');
+
+ if (devDepWithTs !== devDep) {
+ toAppend.push(devDepWithTs);
+ }
+
+ return [...result, ...toAppend];
+ },
+ [],
+ ),
  },
  ],
  },