3 new configurations added: /bun, /jsdoc, and /jsdoc-typescript #16

mangs · 2024-07-11T05:00:53Z

Pull Request Checklist

I have read the CONTRIBUTING document
Readme and changelog updates were made reflecting this PR's changes
Increase the project version number in package.json following Semantic Versioning

Changes Included

Version bump to 2.0.0
Breaking Changes
- Node.js 18.18.0 is now the minimum supported runtime version because of dependency requirements
- ESLint version 8.56.0 is now the minimum supported version
  - Version 9.x cannot be supported yet due to a dependency on the eslint-config-airbnb* packages and its strict peer dependency requirement of no higher than ESLint 8.x
3 new configurations added
- /bun for Bun support
- /jsdoc for JSDoc support in JavaScript projects
- /jsdoc-typescript for JSDoc support in TypeScript projects
Bun replaces NPM as a script runner and package manager for maintenance of this package
When grouping module imports, subpath imports are now treated as part of the 2nd or Internal Imports module imports grouping
Upgrade dependencies to latest versions

mangs

Some notes for context:

mangs · 2024-07-18T01:20:42Z

lib/eslintPlaywrightConfig.json

@@ -1,6 +1,6 @@
 {
  "plugins": ["eslint-plugin-playwright"],
-  "extends": ["plugin:playwright/recommended", "./eslintNodeConfig.json", "eslint-config-prettier"],
+  "extends": ["plugin:playwright/recommended"],


Node.js can no longer be assumed. Could be Bun or Node.

eslint-config-prettier only belongs as the last extends entry, so it should only ever be in one of the environment configs:

Node

Bun

Browser

mangs · 2024-07-18T01:21:55Z

lib/eslintTypescriptConfig.json

@@ -3,14 +3,13 @@
  "parserOptions": {
    "project": ["./tsconfig.json"]
  },
-  "plugins": ["@typescript-eslint/eslint-plugin", "eslint-plugin-import"],


eslint-plugin-import is added in the base config

mangs · 2024-07-18T01:22:43Z

lib/eslintTypescriptConfig.json

    "eslint-config-airbnb-typescript/base",
    "plugin:@typescript-eslint/recommended-type-checked",
    "plugin:@typescript-eslint/stylistic-type-checked",
    "./eslintBaseConfig.json",
-    "eslint-config-prettier"
+    "plugin:import/typescript"


adding to eslint-plugin-import should only happen after it is first added to extends (in eslintBaseConfig.json)

mangs · 2024-07-18T01:22:54Z

package.json

  "author": "Eric L. Goldstein <egoldstein@babbel.com>",
  "description": "Hierarchical ESLint configuration collection that intends to be simple to use, layered, and shared with others",
  "keywords": [
    "eslint",
    "eslintconfig"
  ],
  "engines": {
-    "node": ">=16.13.0"
+    "node": "^18.18.0 || >=20.0.0"


semver breaking change

mangs · 2024-07-18T01:26:15Z

package.json

  },
  "peerDependencies": {
-    "eslint": ">=8.44.0"
+    "eslint": "^8.56.0"


semver breaking change (version bump, and eslint 9 is not allowed due to airbnb incompatibility)

mangs · 2024-07-18T01:27:35Z

test/eslintPlaywrightConfig/.eslintrc.json

@@ -1,4 +1,4 @@
 {
  "root": true,
-  "extends": ["../../lib/eslintPlaywrightConfig.json"]
+  "extends": ["../../lib/eslintPlaywrightConfig.json", "../../lib/eslintNodeConfig.json"]


required for test to pass

mangs · 2024-07-18T01:28:27Z

tsconfig.json


-    // ASTRO BASE TSCONFIG
+    // ASTRO BASE TSCONFIG (https://github.com/withastro/astro/blob/main/packages/astro/tsconfigs/base.json)


here down is a copy of all Astro's tsconfigs

mangs · 2024-07-18T01:28:47Z

tsconfig.json

-    "verbatimModuleSyntax": true,
-    "jsx": "preserve",
+    "allowJs": false,
+    "module": "Preserve",


Bun-compatible module mode (import and require in the same file)

jduthon

Thanks a lot for the added configs and the package updates 👏

I added two minor comments, I think the only one we really need to look into is the postinstall script as I think its implications are unintended, otherwise ready to go!

jduthon · 2024-07-24T13:46:47Z

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog

+## 2.0.0


Maybe we could highlight the breaking changes here for ease of update?

Sure thing, adding

jduthon · 2024-07-24T13:49:06Z

lib/eslintBaseConfig.json

@@ -39,10 +38,9 @@
      {
        "groups": [
          ["builtin", "external"],
-          ["index", "internal", "parent", "sibling"],
+          ["index", "internal", "parent", "sibling", "unknown"],


Changes in this file don't seem to be documented in the Changelog

jduthon · 2024-07-24T14:06:52Z

package.json

-    "validate:formatting": "prettier --check --no-editorconfig .",
-    "validate:linting:eslint": "eslint-config-prettier ./lib/eslintBaseConfig.json"
+    "list:todo-comments": "rg --only-matching '(TODO|FIXME)([\t ]+\\[[^\\]]+\\])?:[\\w\\s!\"#$%&'\\''()+,./:;<=>?@\\^_`{|}~-]+'",
+    "postinstall": "bun run --silent check:environment:versions",


I think you didn't intend this, but postinstall scripts are also ran on consumers' machine, so with those changes, if one tries to run npm i @babbel/eslint-config, after installing the package, npm will attempt to run this script.

Screenshot on my machine after publishing to Verdaccio:

Oh no, I forgot about that. Thank you for pointing that out! I was intending to ensure the proper Bun version was used for maintaining this library.

I tried a few ways to keep it in, but I ended up removing it

Could you have forgotten to push? I don't seem to see any changes

I pushed to origin (my fork) not upstream. I just pushed now. Thanks for pointing that out.

jduthon

Thanks for the changes!
Looking great 🚀

mangs added 16 commits July 11, 2024 00:58

3 new configurations added: /bun, /jsdoc, and /jsdoc-typescript

bb531bc

pr template

0ea25e0

improve order rule for subpath imports, update deps

b5185b0

remove unneeded plugins and extends entries

fe9b80e

update lock

2b043d0

fix test

ba73ac9

update deps

07327ec

enforce expected Bun version when installing packages

469dbdc

add bun install package.json script

aba386f

readme add table of contents and Bun maintenance sections

f5ebeb5

toc

38138ab

changelog

dd2c451

move check:environment:versions from preinstall to postinstall

c702075

readme update

3cf8b4b

changelog

13c9547

readme

980c54b

mangs commented Jul 18, 2024

View reviewed changes

new lock file

61bd2de

mangs marked this pull request as ready for review July 18, 2024 01:30

mangs requested a review from jduthon July 18, 2024 01:30

update dependencies

8dc2635

jduthon reviewed Jul 24, 2024

View reviewed changes

mangs added 5 commits July 24, 2024 13:07

update dependencies

f6cf28b

remove postinstall script so user installs dont break

fa3d256

update deps

ec19b83

changelog update

3af1d9f

changelog update

b2bc96a

mangs requested a review from jduthon July 24, 2024 21:04

jduthon approved these changes Jul 25, 2024

View reviewed changes

mangs merged commit bbbfb6c into main Jul 25, 2024
1 check passed

mangs deleted the add-new-configs branch July 25, 2024 16:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

3 new configurations added: /bun, /jsdoc, and /jsdoc-typescript #16

3 new configurations added: /bun, /jsdoc, and /jsdoc-typescript #16

mangs commented Jul 11, 2024 •

edited

Loading

mangs left a comment

mangs Jul 18, 2024

mangs Jul 18, 2024

mangs Jul 18, 2024

mangs Jul 18, 2024

mangs Jul 18, 2024

mangs Jul 18, 2024

mangs Jul 18, 2024

mangs Jul 18, 2024

mangs Jul 18, 2024

jduthon left a comment

jduthon Jul 24, 2024

mangs Jul 24, 2024

jduthon Jul 24, 2024

mangs Jul 24, 2024

jduthon Jul 24, 2024

mangs Jul 24, 2024 •

edited

Loading

mangs Jul 24, 2024

jduthon Jul 25, 2024

mangs Jul 25, 2024

jduthon left a comment


		// ASTRO BASE TSCONFIG
		// ASTRO BASE TSCONFIG (https://github.com/withastro/astro/blob/main/packages/astro/tsconfigs/base.json)

3 new configurations added: /bun, /jsdoc, and /jsdoc-typescript #16

3 new configurations added: /bun, /jsdoc, and /jsdoc-typescript #16

Conversation

mangs commented Jul 11, 2024 • edited Loading

mangs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jduthon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mangs Jul 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jduthon left a comment

Choose a reason for hiding this comment

mangs commented Jul 11, 2024 •

edited

Loading

mangs Jul 24, 2024 •

edited

Loading