Merge pull request #438 from contentful/refactor/modern-esm-support

BREAKING CHANGE: Discontinued the browser-specific build variant

.circleci/config.yml

@@ -11,9 +11,8 @@ jobs:
     steps:
       - checkout
       - node/install-packages
-      - run: npm run build
-      - run: npm run tsc
       - run: npm run lint
+      - run: npm run build
       - run: npm run prettier:check
       - run: npm run test:cover
   release:

.eslintignore

@@ -1,3 +1,2 @@
 dist
-coverage
-test/.eslintrc.js
+coverage

.eslintrc.js → .eslintrc.cjs

@@ -1,20 +1,19 @@
 module.exports = {
+  parser: '@typescript-eslint/parser',
   overrides: [
     {
-      files: '**/*.js',
-      parser: 'babel-eslint',
-      extends: ['standard', 'prettier'],
-      plugins: ['standard', 'promise'],
-    },
-    {
-      files: '**/*.ts',
+      files: 'src/**/*.ts',
+      parser: '@typescript-eslint/parser',
+      plugins: ['@typescript-eslint'],
       extends: [
         'eslint:recommended',
         'plugin:@typescript-eslint/eslint-recommended',
         'plugin:@typescript-eslint/recommended',
         'prettier',
       ],
-      plugins: ['promise'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 1,
+      },
     },
   ],
-}
+}

.husky/pre-commit

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

.husky/pre-push

@@ -0,0 +1,2 @@
+npm run prettier:check
+npm run test

.prettierrc

@@ -3,6 +3,5 @@
   "tabWidth": 2,
   "useTabs": false,
   "singleQuote": true,
-  "jsxBracketSameLine": true,
   "semi": false
 }

README.md

@@ -25,12 +25,11 @@ This package contains some core modules and utilities used by both the [contentf
 
 ## Support
 
-We support LTS versions of Node.js and all current browsers in their last 3 versions including IE 11.
+This repository is compatible with Node.js version 18 and later. It exclusively provides an ECMAScript Module (ESM) variant, utilizing the `"type": "module"` declaration in `package.json`. Users are responsible for addressing any compatibility issues between ESM and CommonJS (CJS).
 
-### ES2015 modules version
+## Types
 
-For bundlers like webpack2 and rollup we support the `module` &
-`jsnext:main` entry in the package.json
+TypeScript definitions for this repository are available through the `"types"` property in `package.json`.
 
 ## Development
 
@@ -52,22 +51,4 @@ Run unit tests including coverage report:
 
 ```
 npm run test:cover
-```
-
-Run unit tests with coverage report and display the result in your browser:
-
-```
-npm run browser-coverage
-```
-
-Emulate a CI test run:
-
-```
-npm run test:ci-emulate
-```
-
-Enable debug mode for tests:
-
-```
-npm run test:debug
-```
+```