@pingux/astro 2.161.1-alpha.3 → 2.161.1-alpha.5

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/lib/README.md CHANGED
@@ -14,7 +14,7 @@ Yarn:
14
14
 
15
15
  ## Requirements
16
16
 
17
- - Node: 18+
17
+ - Node: 20+
18
18
  - React: 16.8+
19
19
 
20
20
  ## Usage
@@ -33,7 +33,7 @@ import { AstroProvider } from '@pingux/astro';
33
33
 
34
34
  Astro uses [Storybook](https://storybook.js.org/) for component documentation. Once Astro has been cloned, run the following commands to start a local Storybook server:
35
35
 
36
- `yarn start`
36
+ `npx nx start`
37
37
 
38
38
  The Storybook server defaults to `https://localhost:6006`. This port can be customized by running the command start -p 9009. For example, this will start Storybook on port 9009. More information on customizing Storybook CLI options can be found at https://storybook.js.org/docs/react/api/cli-options.
39
39
 
@@ -41,19 +41,23 @@ Component prop documentation is available under the "documentation" tab per each
41
41
 
42
42
  For example, to view the disabled button styling, navigate to the Button story’s props table, locate the "isDisabled" prop, and toggle to "true". This change allows you to preview the disabled button’s styling and functionality.
43
43
 
44
- ## Yarn
45
- We use a modern version of [Yarn](https://yarnpkg.com/getting-started) for package management with the [Plug'n'Play](https://yarnpkg.com/features/pnp) feature enabled. This allows for a [Zero Install](https://yarnpkg.com/features/zero-installs) approach to be used.
44
+ To create a production bundle:
46
45
 
47
- ## Enabling TypeScript in VSCode
46
+ ```sh
47
+ npx nx build astro
48
+ ```
49
+
50
+ To run linting:
48
51
 
49
- To run TypeScript properly, there are a couple of steps to run first:
52
+ ```sh
53
+ npx nx lint astro
54
+ ```
50
55
 
51
- 1. Run `yarn dlx @yarnpkg/sdks vscode` and reload the window to configure vscode for TypeScript.
52
- 2. Open a TypeScript file in VSCode and open the command palette with `cmd + shift + p`.
53
-
54
- a. Search for "TypeScript: Select TypeScript Version..."
55
-
56
- b. Choose "Use Workspace Version"
56
+ To run unit tests:
57
+
58
+ ```sh
59
+ npx nx test astro
60
+ ```
57
61
 
58
62
  ## Browser Compatibility
59
63
 
@@ -28,7 +28,7 @@ Yarn:
28
28
 
29
29
  ### Requirements
30
30
 
31
- - Node: 18+
31
+ - Node: 20+
32
32
  - React: 16.8+
33
33
 
34
34
  ### Usage
@@ -47,7 +47,7 @@ import { AstroProvider } from ‘@pingux/astro’;
47
47
 
48
48
  Astro uses [Storybook](https://storybook.js.org/) for component documentation. Once Astro has been cloned, run the following commands to start a local Storybook server:
49
49
 
50
- `yarn && yarn start`
50
+ Run `npm install` in the root and package level. Followed by `npx nx start` in lib/astro.
51
51
 
52
52
  The Storybook server defaults to `https://localhost:6006`. This port can be customized by running the command start -p 9009. For example, this will start Storybook on port 9009. More information on customizing Storybook CLI options can be found at the [Storybook docs](https://storybook.js.org/docs/react/api/cli-options).
53
53
 
@@ -271,14 +271,14 @@ var buttonBar = {
271
271
  var rockerButton = {
272
272
  innerContainer: {
273
273
  boxShadow: 'none',
274
- backgroundColor: 'common.backgroundBase',
274
+ backgroundColor: 'backgroundBase',
275
275
  borderRadius: '50px',
276
276
  padding: 0,
277
277
  border: 'none'
278
278
  },
279
279
  thumbSwitch: {
280
280
  textTransform: 'none',
281
- backgroundColor: 'common.backgroundBase',
281
+ backgroundColor: 'backgroundBase',
282
282
  padding: 'md',
283
283
  height: '50px',
284
284
  color: 'active',
@@ -28,7 +28,7 @@ Yarn:
28
28
 
29
29
  ### Requirements
30
30
 
31
- - Node: 18+
31
+ - Node: 20+
32
32
  - React: 16.8+
33
33
 
34
34
  ### Usage
@@ -47,7 +47,7 @@ import { AstroProvider } from ‘@pingux/astro’;
47
47
 
48
48
  Astro uses [Storybook](https://storybook.js.org/) for component documentation. Once Astro has been cloned, run the following commands to start a local Storybook server:
49
49
 
50
- `yarn && yarn start`
50
+ Run `npm install` in the root and package level. Followed by `npx nx start` in lib/astro.
51
51
 
52
52
  The Storybook server defaults to `https://localhost:6006`. This port can be customized by running the command start -p 9009. For example, this will start Storybook on port 9009. More information on customizing Storybook CLI options can be found at the [Storybook docs](https://storybook.js.org/docs/react/api/cli-options).
53
53
 
@@ -261,14 +261,14 @@ var buttonBar = {
261
261
  var rockerButton = {
262
262
  innerContainer: {
263
263
  boxShadow: 'none',
264
- backgroundColor: 'common.backgroundBase',
264
+ backgroundColor: 'backgroundBase',
265
265
  borderRadius: '50px',
266
266
  padding: 0,
267
267
  border: 'none'
268
268
  },
269
269
  thumbSwitch: {
270
270
  textTransform: 'none',
271
- backgroundColor: 'common.backgroundBase',
271
+ backgroundColor: 'backgroundBase',
272
272
  padding: 'md',
273
273
  height: '50px',
274
274
  color: 'active',