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.

Sign up for GitHub

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

Fix generated ESM, revamp build system #113

Merged
merged 19 commits into from
Jul 31, 2023
Merged

Fix generated ESM, revamp build system #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
0f5bf98
replace build system with svelte-package. refactor for typescript. lo…
hobbes7878 Jul 19, 2023
67bc5e4
adds test-runner
hobbes7878 Jul 20, 2023
53f31e9
resolve merge conflicts
hobbes7878 Jul 20, 2023
40c1152
await click in interaction test
hobbes7878 Jul 20, 2023
25a4298
finish tests with vitest. cleanup deps and package.json
hobbes7878 Jul 20, 2023
02ce02a
fix dedent dependency
hobbes7878 Jul 20, 2023
5857238
Update src/plugins/vite-svelte-csf.ts
hobbes7878 Jul 26, 2023
fa5505b
adds handling for Windows paths
hobbes7878 Jul 26, 2023
70c1500
Apply suggestions from code review
hobbes7878 Jul 29, 2023
9abce0f
cleanup scripts and expand vite peer deps range
hobbes7878 Jul 29, 2023
139f47e
strict typescript
hobbes7878 Jul 29, 2023
920391d
force resolutions of string-width and wrap-ansi
hobbes7878 Jul 29, 2023
acf9548
fix node-logger calls so just one arg is passed
hobbes7878 Jul 29, 2023
079431e
fix a few outstanding type errors in parser and preset
hobbes7878 Jul 29, 2023
529e422
stray comment
hobbes7878 Jul 29, 2023
7aad038
convert to pnpm
hobbes7878 Jul 29, 2023
78fc850
regen lockfile
hobbes7878 Jul 29, 2023
9cebdba
add fetch depth for actions/checkout@v3
hobbes7878 Jul 29, 2023
4269195
cleanup package.json scripts and pnpm in release workflow
hobbes7878 Jul 31, 2023
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
20 changes: 0 additions & 20 deletions .babelrc.js
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = {
root: true,
extends: ['@storybook/eslint-config-storybook'],
extends: ['plugin:storybook/recommended'],
rules: {
'@typescript-eslint/dot-notation': 'off',
'@typescript-eslint/no-implied-eval': 'off',
Expand Down
13 changes: 11 additions & 2 deletions .github/workflows/chromatic.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,18 @@ jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Install Node.js
uses: actions/setup-node@v3
with:
node-version: 20
- name: Install dependencies
run: yarn
uses: pnpm/action-setup@v2
with:
version: 8
run_install: true
- name: Publish to Chromatic
uses: chromaui/action@v1
with:
Expand Down
11 changes: 7 additions & 4 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,25 @@ jobs:
runs-on: ubuntu-latest
if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- name: Prepare repository
run: git fetch --unshallow --tags

- name: Use Node.js 20.x
uses: actions/setup-node@v1
uses: actions/setup-node@v3
with:
node-version: 20.x

- name: Install dependencies
uses: bahmutov/npm-install@v1
uses: pnpm/action-setup@v2
with:
version: 8
run_install: true

- name: Create Release
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
yarn release
pnpm run release
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ storybook-static/
build-storybook.log
package-lock.json
.DS_Store
.env
.env
*.log
13 changes: 0 additions & 13 deletions .storybook/main.js
View file
Open in desktop

This file was deleted.

14 changes: 14 additions & 0 deletions .storybook/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import type { StorybookConfig } from '@storybook/svelte-vite';

const config: StorybookConfig = {
framework: '@storybook/svelte-vite',
stories: [
'../stories/**/*.stories.svelte',
],
addons: [
'../dist/preset/index.js',
'@storybook/addon-essentials',
'@storybook/addon-interactions',
],
};
export default config;
1 change: 0 additions & 1 deletion index.js
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion jest-transform.js
View file
Open in desktop

This file was deleted.

18 changes: 0 additions & 18 deletions jest.config.js
View file
Open in desktop

This file was deleted.

102 changes: 57 additions & 45 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,21 @@
"url": "https://github.com/storybookjs/addon-svelte-csf"
},
"license": "MIT",
"main": "dist/cjs/index.js",
"module": "dist/esm/index.js",
"browser": "dist/cjs/index.js",
Comment on lines -14 to -16
Copy link
Member

@ndelangen ndelangen Jul 25, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You say this works in storybook?
I would expect this to be broken, but honestly I've not yet tried, so maybe I'm wrong.

What i know of the preset-loading mechanism in storybook is what when an addon-entry is added, storybook will try resolving ${name}/preset (with node).
It will do the same for manager and preview FYI.

Maybe with type: module these exports fields are actually respected/used?
If so that's great!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, type: "module" is the key there as far as I understand it, which is mostly from sindresorhus's explanation...

But yes, working in Node 16+ with Storybook 7.1+ in the repo.

"type": "module",
"exports": {
".": {
"svelte": "./dist/index.js",
"types": "./dist/index.d.ts"
},
"./preset": {
"types": "./dist/preset/index.d.ts",
"default": "./dist/preset/index.js"
},
"./manager": {
"types": "./dist/preset/manager.d.ts",
"default": "./dist/preset/manager.js"
}
},
"files": [
"dist/**/*",
"README.md",
Expand All @@ -22,64 +34,64 @@
],
"scripts": {
"clean": "rimraf ./dist",
"build": "concurrently \"yarn build:cjs\" \"yarn build:esm\"",
"build:cjs": "babel ./src -d ./dist/cjs --extensions \".js,.ts\" --copy-files",
"build:esm": "babel ./src -d ./dist/esm --env-name esm --extensions \".js,.ts\" --copy-files",
"prepublish": "yarn clean && yarn build",
"test": "jest",
"build": "svelte-package --input ./src --types",
"prepublish": "pnpm run clean && pnpm run build",
"test": "vitest run",
"chromatic": "chromatic --exit-zero-on-changes",
"coverage": "vitest run --coverage",
"lint": "eslint --cache --cache-location=.cache/eslint --ext .js,.jsx,.json,.html,.ts,.tsx,.mjs --report-unused-disable-directives",
"storybook": "sb dev -p 6006",
"start": "concurrently \"yarn storybook --quiet\" \"yarn build -- --watch\"",
"build-storybook": "sb build",
"release": "yarn build && auto shipit"
"storybook": "storybook dev --port 6006",
"start": "concurrently \"pnpm run storybook --quiet\" \"pnpm run build --watch\"",
"build-storybook": "storybook build",
"release": "pnpm run build && auto shipit"
},
"dependencies": {
"@babel/runtime": "^7.21.0",
"@babel/runtime": "^7.22.6",
"dedent": "^1.2.0",
"fs-extra": "^11.1.1",
"magic-string": "^0.30.0",
"ts-dedent": "^2.0.0"
"magic-string": "^0.30.1"
},
"devDependencies": {
"@auto-it/released": "^10.32.6",
"@babel/cli": "^7.21.0",
"@babel/core": "^7.21.4",
"@babel/plugin-transform-runtime": "^7.21.4",
"@babel/preset-env": "^7.21.4",
"@babel/preset-react": "^7.18.6",
"@babel/preset-typescript": "^7.21.4",
"@storybook/addon-essentials": "^7.0.27",
"@storybook/addon-interactions": "^7.0.27",
"@storybook/addon-storyshots": "^7.0.27",
"@storybook/core-client": "^7.0.27",
"@storybook/core-server": "^7.0.27",
"@storybook/addon-actions": "^7.1.1",
"@storybook/addon-essentials": "^7.1.1",
"@storybook/addon-interactions": "^7.1.1",
"@storybook/client-api": "^7.1.1",
"@storybook/client-logger": "^7.1.1",
"@storybook/core-client": "^7.1.1",
"@storybook/core-server": "^7.1.1",
"@storybook/csf": "^0.1.1",
"@storybook/eslint-config-storybook": "^3.1.2",
"@storybook/jest": "^0.0.10",
"@storybook/svelte": "^7.0.27",
"@storybook/svelte-webpack5": "^7.0.27",
"@storybook/testing-library": "^0.0.13",
"@storybook/types": "^7.0.27",
"@storybook/jest": "^0.1.0",
"@storybook/svelte": "^7.1.1",
"@storybook/svelte-vite": "^7.1.1",
"@storybook/test-runner": "^0.11.0",
"@storybook/testing-library": "^0.2.0",
"@storybook/types": "^7.1.1",
"@sveltejs/package": "^2.2.0",
"@sveltejs/vite-plugin-svelte": "^2.4.2",
"@tsconfig/svelte": "^5.0.0",
"auto": "^10.43.0",
"babel-jest": "^29.5.0",
"babel-loader": "^8.1.0",
"chromatic": "^6.17.2",
"concurrently": "^6.2.0",
"chromatic": "^6.19.9",
"concurrently": "^8.2.0",
"eslint": "^7.17.0",
"jest": "^29.5.0",
"jest-environment-jsdom": "^29.5.0",
"prettier": "^2.8.7",
"react": "^17.0.1",
"react-dom": "^17.0.1",
"eslint-plugin-storybook": "^0.6.12",
"jsdom": "^22.1.0",
"prettier": "^3.0.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"rimraf": "^3.0.2",
"sb": "^7.0.27",
"storybook": "^7.1.1",
"svelte": "^4.0.0",
"svelte-jester": "^2.3.2",
"svelte-loader": "^3.1.7",
"typescript": "^5.0.0",
"vite": "^3.1.4"
"typescript": "^5.1.6",
"vite": "^4.4.3",
"vitest": "^0.33.0"
},
"peerDependencies": {
"@storybook/svelte": "^7.0.0-beta.0 || ^7.0.0-rc.0 || ^7.0.0",
"@storybook/theming": "^7.0.0-beta.0 || ^7.0.0-rc.0 || ^7.0.0",
"@storybook/svelte": "^7.0.0",
"@storybook/theming": "^7.0.0",
"@sveltejs/vite-plugin-svelte": "^1.0.0 || ^2.0.0",
"svelte": "^3.50.0 || ^4.0.0",
"svelte-loader": "^3.1.2",
Expand Down
Loading