build: migrate to ESM

BREAKING CHANGE: This package is now packaged using ESM.

Stryker has been removed due to its poor support for ESM environments.

.github/workflows/nodejs.yml

@@ -15,8 +15,8 @@ jobs:
         run: npm ci
       - name: Run tests
         run: npm test -- --ci
-      - name: Run Stryker
-        run: npx stryker run
+      # - name: Run Stryker
+      #   run: npx stryker run
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v2.1.0
         with:

.storybook/main.js

@@ -2,7 +2,7 @@ module.exports = {
   stories: ["../src/**/*.stories.mdx", "../src/**/*.stories.@(js|jsx|ts|tsx)"],
   addons: [
     "@storybook/addon-links",
-    "@storybook/addon-essentials",
     "@storybook/addon-docs",
+    "@storybook/addon-essentials",
   ],
 };

.storybook/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

README.md

@@ -14,6 +14,8 @@ The most notable "theming" feature of these components is their automatic dark m
 npm install starstuff-components
 ```
 
+This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c);
+
 ## Usage
 
 All components can be access via named exports on the `starstuff-components` package. Detailed examples for each component can be seen below.

jest.config.js → jest.config.cjs

@@ -11,10 +11,18 @@ module.exports = {
   projects: [
     {
       displayName: "test",
-      preset: "ts-jest",
+      preset: "ts-jest/presets/default-esm",
       snapshotSerializers: ["@emotion/jest/serializer"],
       testPathIgnorePatterns,
       collectCoverage: true,
+      globals: {
+        "ts-jest": {
+          useESM: true,
+        },
+      },
+      moduleNameMapper: {
+        "^(\\.{1,2}/.*)\\.js$": "$1",
+      },
     },
     {
       displayName: "lint:prettier",

package.json

@@ -2,7 +2,12 @@
   "name": "starstuff-components",
   "version": "0.0.0-development",
   "description": "Minimalistic React Component Library",
-  "main": "dist/index.js",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+  },
   "scripts": {
     "build": "tsc",
     "prepack": "tsc",

src/Card/index.test.tsx

@@ -3,7 +3,7 @@
  */
 
 import * as React from "react";
-import renderer from "react-test-renderer";
+import * as renderer from "react-test-renderer";
 import { Card } from ".";
 
 describe("Card", () => {

src/Hyperbutton/index.test.tsx

@@ -3,7 +3,7 @@
  */
 
 import * as React from "react";
-import renderer from "react-test-renderer";
+import * as renderer from "react-test-renderer";
 import { Hyperbutton } from ".";
 
 describe("Hyperbutton", (): void => {

src/Hyperlink/index.test.tsx

@@ -3,7 +3,7 @@
  */
 
 import * as React from "react";
-import renderer from "react-test-renderer";
+import * as renderer from "react-test-renderer";
 import { Hyperlink } from ".";
 
 describe("Hyperlink", (): void => {

src/index.ts

@@ -1,3 +1,3 @@
-export { Card } from "./Card";
-export { Hyperbutton } from "./Hyperbutton";
-export { Hyperlink } from "./Hyperlink";
+export { Card } from "./Card/index.js";
+export { Hyperbutton } from "./Hyperbutton/index.js";
+export { Hyperlink } from "./Hyperlink/index.js";

tsconfig.json

@@ -2,8 +2,8 @@
   "compilerOptions": {
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
-    "target": "ES2018" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
-    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    "target": "ES2020" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+    "module": "ES2020" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
     // "lib": [],                             /* Specify library files to be included in the compilation. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
@@ -39,14 +39,14 @@
     // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
 
     /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
     // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
     // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
     // "types": [],                           /* Type declaration files to be included in compilation. */
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
     // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */