Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite build/setup and hopefully fix ESM compat #4511

Merged
merged 5 commits into from
Apr 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions .codesandbox/ci.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
{
"sandboxes": [
"vanilla",
"vanilla-ts"
],
"node": "14"
"sandboxes": ["vanilla", "vanilla-ts"],
"node": "16"
}
71 changes: 71 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,74 @@ jobs:
yarn tsc --version
yarn check-types
yarn test:types

test-published-artifact:
name: Test Published Artifact ${{ matrix.example }}

needs: [build]
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
node: ['16.x']
example:
[
'cra4',
'cra5',
'next',
'vite',
'node-standard',
'node-esm',
'are-the-types-wrong'
]
steps:
- name: Checkout repo
uses: actions/checkout@v2

- name: Use node ${{ matrix.node }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node }}
cache: 'yarn'

- name: Clone RTK repo
run: git clone https://github.com/reduxjs/redux-toolkit.git ./redux-toolkit

- name: Check folder contents
run: ls -l .

- name: Install deps
working-directory: ./redux-toolkit/examples/publish-ci/${{ matrix.example }}
run: yarn install

- uses: actions/download-artifact@v2
with:
name: package
path: ./redux-toolkit/examples/publish-ci/${{ matrix.example }}

- name: Check folder contents
working-directory: ./redux-toolkit/examples/publish-ci/${{ matrix.example }}
run: ls -l .

- name: Install build artifact
working-directory: ./redux-toolkit/examples/publish-ci/${{ matrix.example }}
run: yarn add ./package.tgz

- name: Show installed package versions
working-directory: ./redux-toolkit/examples/publish-ci/${{ matrix.example }}
run: yarn info redux && yarn why redux

- name: Build example
working-directory: ./redux-toolkit/examples/publish-ci/${{ matrix.example }}
run: yarn build

- name: Run test step
working-directory: ./redux-toolkit/examples/publish-ci/${{ matrix.example }}
run: yarn test
if: matrix.example != 'are-the-types-wrong'

- name: Run test step
working-directory: ./redux-toolkit/examples/publish-ci/${{ matrix.example }}
# Ignore "FalseCJS" errors in the `attw` job
run: yarn test -n FalseCJS
if: matrix.example == 'are-the-types-wrong'
24 changes: 11 additions & 13 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,23 @@
"Dan Abramov <dan.abramov@me.com> (https://github.com/gaearon)",
"Andrew Clark <acdlite@me.com> (https://github.com/acdlite)"
],
"type": "module",
"module": "dist/es/index.js",
"main": "dist/cjs/index.cjs",
"types": "types/index.d.ts",
"main": "dist/cjs/redux.cjs",
"module": "dist/redux.mjs",
"types": "dist/redux.d.ts",
"exports": {
"./package.json": "./package.json",
".": {
"types": "./types/index.d.ts",
"import": "./dist/es/index.js",
"default": "./dist/cjs/index.cjs"
"types": "./dist/redux.d.ts",
"import": "./dist/redux.mjs",
"default": "./dist/cjs/redux.cjs"
}
},
"files": [
"dist",
"lib",
"es",
"src",
"types"
"src"
],
"scripts": {
"clean": "rimraf lib dist es coverage types",
"clean": "rimraf dist",
"format": "prettier --write \"{src,test}/**/*.{js,ts}\" \"**/*.md\"",
"format:check": "prettier --list-different \"{src,test}/**/*.{js,ts}\" \"**/*.md\"",
"lint": "eslint --ext js,ts src test",
Expand All @@ -52,7 +48,7 @@
"test:types": "tsc -p test/typescript && echo \"Typetests passed\"",
"test:watch": "vitest",
"test:cov": "vitest --coverage",
"build": "rollup -c",
"build": "tsup",
"prepublishOnly": "yarn clean && yarn check-types && yarn format:check && yarn lint && yarn test",
"prepack": "yarn build",
"examples:lint": "eslint --ext js,ts examples",
Expand All @@ -79,6 +75,7 @@
"@typescript-eslint/eslint-plugin": "^5.36.2",
"@typescript-eslint/parser": "^5.36.2",
"cross-env": "^7.0.3",
"esbuild-extra": "^0.1.3",
"eslint": "^8.23.0",
"eslint-config-react-app": "^7.0.1",
"eslint-import-resolver-typescript": "^3.5.1",
Expand All @@ -94,6 +91,7 @@
"rollup": "^3.12.0",
"rollup-plugin-typescript2": "^0.34.1",
"rxjs": "^7.5.6",
"tsup": "^6.7.0",
"typescript": "^4.8.3",
"vitest": "^0.27.2"
},
Expand Down
12 changes: 6 additions & 6 deletions scripts/mangleErrors.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,12 @@ module.exports = babel => {
}

// Import the error message function
const formatProdErrorMessageIdentifier =
helperModuleImports.addDefault(
path,
'src/utils/formatProdErrorMessage',
{ nameHint: 'formatProdErrorMessage' }
)
const formatProdErrorMessageIdentifier = helperModuleImports.addNamed(
path,
'formatProdErrorMessage',
'src/utils/formatProdErrorMessage',
{ nameHint: 'formatProdErrorMessage' }
)

// Creates a function call to output the message to the error code page on the website
const prodMessage = t.callExpression(
Expand Down
3 changes: 2 additions & 1 deletion src/types/store.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { Action, AnyAction } from './actions'
import { Reducer } from './reducers'
import '../utils/symbol-observable'
// eslint-disable-next-line @typescript-eslint/no-unused-vars
import _$$observable from '../utils/symbol-observable'

/**
* Internal "virtual" symbol used to make the `CombinedState` type unique.
Expand Down
4 changes: 1 addition & 3 deletions src/utils/formatProdErrorMessage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@
* during build.
* @param {number} code
*/
function formatProdErrorMessage(code: number) {
export function formatProdErrorMessage(code: number) {
return (
`Minified Redux error #${code}; visit https://redux.js.org/Errors?code=${code} for the full message or ` +
'use the non-minified dev environment for full errors. '
)
}

export default formatProdErrorMessage
2 changes: 1 addition & 1 deletion test/utils/formatProdErrorMessage.spec.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import formatProdErrorMessage from '@internal/utils/formatProdErrorMessage'
import { formatProdErrorMessage } from '@internal/utils/formatProdErrorMessage'

describe('formatProdErrorMessage', () => {
it('returns message with expected code references', () => {
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"noUnusedLocals": true,
"noUnusedParameters": true,
"baseUrl": "./",
"types": ["vitest/globals"],
"types": ["vitest/globals", "esbuild-extra/global"],
"paths": {
"redux": ["src/index.ts"], // @remap-prod-remove-line
"@internal/*": ["src/*"]
Expand Down
67 changes: 67 additions & 0 deletions tsup.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
import { defineConfig, Options } from 'tsup'

import * as babel from '@babel/core'
import { Plugin } from 'esbuild'
import { getBuildExtensions } from 'esbuild-extra'

// Extract error strings, replace them with error codes, and write messages to a file
const mangleErrorsTransform: Plugin = {
name: 'mangle-errors-plugin',
setup(build) {
const { onTransform } = getBuildExtensions(build, 'mangle-errors-plugin')

onTransform({ loaders: ['ts', 'tsx'] }, async args => {
const res = babel.transformSync(args.code, {
parserOpts: {
plugins: ['typescript']
},
plugins: [['./scripts/mangleErrors.cjs', { minify: false }]]
})!
return {
code: res.code!,
map: res.map!
}
})
}
}

export default defineConfig(options => {
const commonOptions: Partial<Options> = {
entry: {
redux: 'src/index.ts'
},
esbuildPlugins: [mangleErrorsTransform],
sourcemap: true,
...options
}

return [
// Standard ESM, embedded `process.env.NODE_ENV` checks
{
...commonOptions,
format: ['esm'],
outExtension: () => ({ js: '.mjs' }),
dts: true,
clean: true
},
// Browser-ready ESM, production + minified
{
...commonOptions,
entry: {
'redux.browser': 'src/index.ts'
},
define: {
'process.env.NODE_ENV': JSON.stringify('production')
},
format: ['esm'],
outExtension: () => ({ js: '.mjs' }),
minify: true
},
{
...commonOptions,
format: 'cjs',
outDir: './dist/cjs/',
outExtension: () => ({ js: '.cjs' })
}
]
})
Loading