@storybook/addon-onboarding 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Storybook contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,61 @@
1
+ # Storybook Addon Addon Onboarding
2
+
3
+ Storybook Addon Onboarding - Introduces a new onboarding experience
4
+
5
+ ### Development scripts
6
+
7
+ - `yarn start` runs babel in watch mode and starts Storybook
8
+ - `yarn build` build and package your addon code
9
+
10
+ ## Release Management
11
+
12
+ ### Setup
13
+
14
+ This project is configured to use [auto](https://github.com/intuit/auto) for release management. It generates a changelog and pushes it to both GitHub and npm. Therefore, you need to configure access to both:
15
+
16
+ - [`NPM_TOKEN`](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-access-tokens) Create a token with both _Read and Publish_ permissions.
17
+ - [`GH_TOKEN`](https://github.com/settings/tokens) Create a token with the `repo` scope.
18
+
19
+ Then open your `package.json` and edit the following fields:
20
+
21
+ - `name`
22
+ - `author`
23
+ - `repository`
24
+
25
+ #### Local
26
+
27
+ To use `auto` locally create a `.env` file at the root of your project and add your tokens to it:
28
+
29
+ ```bash
30
+ GH_TOKEN=<value you just got from GitHub>
31
+ NPM_TOKEN=<value you just got from npm>
32
+ ```
33
+
34
+ Lastly, **create labels on GitHub**. You’ll use these labels in the future when making changes to the package.
35
+
36
+ ```bash
37
+ npx auto create-labels
38
+ ```
39
+
40
+ If you check on GitHub, you’ll now see a set of labels that `auto` would like you to use. Use these to tag future pull requests.
41
+
42
+ #### GitHub Actions
43
+
44
+ This template comes with GitHub actions already set up to publish your addon anytime someone pushes to your repository.
45
+
46
+ Go to `Settings > Secrets`, click `New repository secret`, and add your `NPM_TOKEN`.
47
+
48
+ ### Creating a release
49
+
50
+ To create a release locally you can run the following command, otherwise the GitHub action will make the release for you.
51
+
52
+ ```sh
53
+ yarn release
54
+ ```
55
+
56
+ That will:
57
+
58
+ - Build and package the addon code
59
+ - Bump the version
60
+ - Push a release to GitHub and npm
61
+ - Push a changelog to GitHub
package/auto.config.js ADDED
@@ -0,0 +1,11 @@
1
+ module.exports = {
2
+ baseBranch: "main",
3
+ labels: [
4
+ {
5
+ name: "documentation",
6
+ releaseType: "none",
7
+ },
8
+ ],
9
+ prereleaseBranches: ["next", "prerelease"],
10
+ versionBranches: true,
11
+ };
@@ -0,0 +1,3 @@
1
+ declare const _default: {};
2
+
3
+ export { _default as default };
package/dist/index.js ADDED
@@ -0,0 +1,7 @@
1
+ 'use strict';
2
+
3
+ var e={};
4
+
5
+ module.exports = e;
6
+ //# sourceMappingURL=out.js.map
7
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts"],"names":["src_default"],"mappings":"AACA,IAAOA,EAAQ,CAAC","sourcesContent":["// make it work with --isolatedModules\nexport default {};\n"]}
package/dist/index.mjs ADDED
@@ -0,0 +1,5 @@
1
+ var e={};
2
+
3
+ export { e as default };
4
+ //# sourceMappingURL=out.js.map
5
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts"],"names":["src_default"],"mappings":"AACA,IAAOA,EAAQ,CAAC","sourcesContent":["// make it work with --isolatedModules\nexport default {};\n"]}
@@ -0,0 +1,2 @@
1
+
2
+ export { }
@@ -0,0 +1,5 @@
1
+ 'use strict';
2
+
3
+ console.log("Addon Onboarding");
4
+ //# sourceMappingURL=out.js.map
5
+ //# sourceMappingURL=manager.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/manager.ts"],"names":[],"mappings":"AAAA,QAAQ,IAAI,kBAAkB","sourcesContent":["console.log(\"Addon Onboarding\");\n\nexport {};\n"]}
@@ -0,0 +1,3 @@
1
+ console.log("Addon Onboarding");
2
+ //# sourceMappingURL=out.js.map
3
+ //# sourceMappingURL=manager.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/manager.ts"],"names":[],"mappings":"AAAA,QAAQ,IAAI,kBAAkB","sourcesContent":["console.log(\"Addon Onboarding\");\n\nexport {};\n"]}
@@ -0,0 +1,9 @@
1
+ import { ProjectAnnotations, Renderer } from '@storybook/types';
2
+
3
+ /**
4
+ * Note: if you want to use JSX in this file, rename it to `preview.tsx`
5
+ * and update the entry prop in tsup.config.ts to use "src/preview.tsx",
6
+ */
7
+ declare const preview: ProjectAnnotations<Renderer>;
8
+
9
+ export { preview as default };
@@ -0,0 +1,7 @@
1
+ 'use strict';
2
+
3
+ var e={},o=e;
4
+
5
+ module.exports = o;
6
+ //# sourceMappingURL=out.js.map
7
+ //# sourceMappingURL=preview.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/preview.ts"],"names":["preview","preview_default"],"mappings":"AAOA,IAAMA,EAAwC,CAAC,EAExCC,EAAQD","sourcesContent":["import type { Renderer, ProjectAnnotations } from \"@storybook/types\";\n\n/**\n * Note: if you want to use JSX in this file, rename it to `preview.tsx`\n * and update the entry prop in tsup.config.ts to use \"src/preview.tsx\",\n */\n\nconst preview: ProjectAnnotations<Renderer> = {};\n\nexport default preview;\n"]}
@@ -0,0 +1,5 @@
1
+ var e={},o=e;
2
+
3
+ export { o as default };
4
+ //# sourceMappingURL=out.js.map
5
+ //# sourceMappingURL=preview.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/preview.ts"],"names":["preview","preview_default"],"mappings":"AAOA,IAAMA,EAAwC,CAAC,EAExCC,EAAQD","sourcesContent":["import type { Renderer, ProjectAnnotations } from \"@storybook/types\";\n\n/**\n * Note: if you want to use JSX in this file, rename it to `preview.tsx`\n * and update the entry prop in tsup.config.ts to use \"src/preview.tsx\",\n */\n\nconst preview: ProjectAnnotations<Renderer> = {};\n\nexport default preview;\n"]}
package/manager.js ADDED
@@ -0,0 +1 @@
1
+ export * from "./dist/manager";
package/package.json ADDED
@@ -0,0 +1,107 @@
1
+ {
2
+ "name": "@storybook/addon-onboarding",
3
+ "version": "0.0.1",
4
+ "description": "Storybook Addon Onboarding - Introduces a new onboarding experience",
5
+ "keywords": [
6
+ "storybook-addons",
7
+ "addon-onboarding"
8
+ ],
9
+ "repository": {
10
+ "type": "git",
11
+ "url": "https://github.com/storybookjs/addon-onboarding"
12
+ },
13
+ "author": "@storybookjs/core",
14
+ "license": "MIT",
15
+ "exports": {
16
+ ".": {
17
+ "require": "./dist/index.js",
18
+ "import": "./dist/index.mjs",
19
+ "types": "./dist/index.d.ts"
20
+ },
21
+ "./manager": {
22
+ "require": "./dist/manager.js",
23
+ "import": "./dist/manager.mjs",
24
+ "types": "./dist/manager.d.ts"
25
+ },
26
+ "./preview": {
27
+ "require": "./dist/preview.js",
28
+ "import": "./dist/preview.mjs",
29
+ "types": "./dist/preview.d.ts"
30
+ },
31
+ "./package.json": "./package.json"
32
+ },
33
+ "main": "dist/index.js",
34
+ "module": "dist/index.mjs",
35
+ "types": "dist/index.d.ts",
36
+ "files": [
37
+ "dist/**/*",
38
+ "README.md",
39
+ "*.js",
40
+ "*.d.ts"
41
+ ],
42
+ "scripts": {
43
+ "clean": "rimraf ./dist",
44
+ "prebuild": "yarn clean",
45
+ "build": "tsup",
46
+ "build:watch": "yarn build --watch",
47
+ "test": "echo \"Error: no test specified\" && exit 1",
48
+ "start": "run-p build:watch 'storybook --quiet'",
49
+ "prerelease": "zx scripts/prepublish-checks.mjs",
50
+ "release": "yarn build && auto shipit",
51
+ "eject-ts": "zx scripts/eject-typescript.mjs",
52
+ "storybook": "storybook dev -p 6006",
53
+ "build-storybook": "storybook build"
54
+ },
55
+ "devDependencies": {
56
+ "@storybook/addon-essentials": "^7.0.0",
57
+ "@storybook/addon-interactions": "^7.0.0",
58
+ "@storybook/addon-links": "^7.0.0",
59
+ "@storybook/react": "^7.0.0",
60
+ "@storybook/react-vite": "^7.0.0",
61
+ "@storybook/testing-library": "^0.0.14-next.1",
62
+ "@types/node": "^18.15.0",
63
+ "@types/react": "^18.0.34",
64
+ "@vitejs/plugin-react": "^3.1.0",
65
+ "auto": "^10.3.0",
66
+ "boxen": "^5.0.1",
67
+ "dedent": "^0.7.0",
68
+ "npm-run-all": "^4.1.5",
69
+ "prettier": "^2.3.1",
70
+ "prompts": "^2.4.2",
71
+ "prop-types": "^15.8.1",
72
+ "react": "^18.0.0",
73
+ "react-dom": "^18.0.0",
74
+ "rimraf": "^3.0.2",
75
+ "storybook": "^7.0.0",
76
+ "tsup": "^6.6.3",
77
+ "typescript": "^4.9.5",
78
+ "vite": "^4.1.4",
79
+ "zx": "^1.14.1"
80
+ },
81
+ "peerDependencies": {
82
+ "@storybook/blocks": "^7.0.0",
83
+ "@storybook/components": "^7.0.0",
84
+ "@storybook/core-events": "^7.0.0",
85
+ "@storybook/manager-api": "^7.0.0",
86
+ "@storybook/preview-api": "^7.0.0",
87
+ "@storybook/theming": "^7.0.0",
88
+ "@storybook/types": "^7.0.0",
89
+ "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
90
+ "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
91
+ },
92
+ "peerDependenciesMeta": {
93
+ "react": {
94
+ "optional": true
95
+ },
96
+ "react-dom": {
97
+ "optional": true
98
+ }
99
+ },
100
+ "publishConfig": {
101
+ "access": "public"
102
+ },
103
+ "storybook": {
104
+ "displayName": "Addon Onboarding",
105
+ "icon": "https://user-images.githubusercontent.com/321738/63501763-88dbf600-c4cc-11e9-96cd-94adadc2fd72.png"
106
+ }
107
+ }
package/preview.js ADDED
@@ -0,0 +1 @@
1
+ export * from "./dist/preview";