@brightspace-ui/create - npm Package Compare versions

Comparing version 1.9.0 to 1.10.0

dist/generators/default-content/templates/configured/_package.json

 {
   "name": "<%= packageName %>",
   "description": "<%= description %>",
+  "type": "module",
   "repository": "https://github.com/<%= githubOrg %>/<%= hyphenatedName %>.git",
@@ -5,0 +6,0 @@ "scripts": {

dist/generators/localization/templates/configured/_element.serge.json

@@ -8,17 +8,3 @@ {
   "source_dir": "lang",
-  "output_file_path": "lang/%LANG%.js",
-  "output_lang_rewrite": [
-    "ar-sa ar",
-    "cy-gb cy",
-    "da-dk da",
-    "de-de de",
-    "es-mx es",
-    "fr-ca fr",
-    "ja-jp ja",
-    "ko-kr ko",
-    "nl-nl nl",
-    "pt-br pt",
-    "sv-se sv",
-    "tr-tr tr"
-  ]
+  "output_file_path": "lang/%LANG%.js"
 }

dist/generators/release/templates/configured/_README.md

@@ -6,3 +6,3 @@
 
-The [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/master/semantic-release) is called from the `release.yml` GitHub Action workflow to handle version changes and releasing.
+The [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) is called from the `release.yml` GitHub Action workflow to handle version changes and releasing.
 
@@ -9,0 +9,0 @@ ### Version Changes

dist/generators/test-unit/index.js

@@ -15,5 +15,5 @@ "use strict";
   (0, _helper.replaceText)(`${(0, _helper.getDestinationPath)(templateData.hyphenatedName)}/test/${templateData.hyphenatedName}.test.js`, templateData);
-  (0, _helper.copyFile)(`${__dirname}/templates/configured/_web-test-runner.sauce.config.mjs`, `${(0, _helper.getDestinationPath)(templateData.hyphenatedName)}/web-test-runner.sauce.config.mjs`);
-  (0, _helper.replaceText)(`${(0, _helper.getDestinationPath)(templateData.hyphenatedName)}/web-test-runner.sauce.config.mjs`, templateData);
+  (0, _helper.copyFile)(`${__dirname}/templates/configured/_web-test-runner.sauce.config.js`, `${(0, _helper.getDestinationPath)(templateData.hyphenatedName)}/web-test-runner.sauce.config.js`);
+  (0, _helper.replaceText)(`${(0, _helper.getDestinationPath)(templateData.hyphenatedName)}/web-test-runner.sauce.config.js`, templateData);
   (0, _helper.copyFilesInDir)(`${__dirname}/templates/static`, (0, _helper.getDestinationPath)(templateData.hyphenatedName));
 }

dist/generators/test-visual-diff/templates/_element.visual-diff.js

 import puppeteer from 'puppeteer';
-import VisualDiff from '@brightspace-ui/visual-diff';
+import { VisualDiff } from '@brightspace-ui/visual-diff';
 
 describe('<%= tagName %>', () => {
 
-	const visualDiff = new VisualDiff('<%= hyphenatedName %>', __dirname);
+	const visualDiff = new VisualDiff('<%= hyphenatedName %>', import.meta.url);
 
@@ -8,0 +8,0 @@ let browser, page;

dist/generators/test-visual-diff/templates/_README.md

@@ -6,15 +6,21 @@
 
-The golden snapshots in source control must be updated by Github Actions.  If your PR's code changes result in visual differences, a draft PR with the new goldens will be automatically opened for you against your branch.
+The golden snapshots in source control must be updated by the [visual-diff GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/visual-diff).  If a pull request results in visual differences, a draft pull request with the new goldens will automatically be opened against its branch.
 
-If you'd like to run the tests locally to help troubleshoot or develop new tests, you can use these commands:
+To run the tests locally to help troubleshoot or develop new tests, first install these dependencies:
 
 ```shell
-# install dependencies locally
-npm install esm mocha puppeteer @brightspace-ui/visual-diff --no-save
+npm install @brightspace-ui/visual-diff@X mocha@Y puppeteer@Z  --no-save
+```
+
+Replace `X`, `Y` and `Z` with [the current versions](https://github.com/BrightspaceUI/actions/tree/main/visual-diff#current-dependency-versions) the action is using.
+
+Then run the tests:
+
+```shell
 # run visual-diff tests
-npx mocha './test/**/*.visual-diff.js' -t 10000 --require esm
+npx mocha './test/**/*.visual-diff.js' -t 10000
 # subset of visual-diff tests:
-npx mocha './test/**/*.visual-diff.js' -t 10000 --require esm -g some-pattern
+npx mocha './test/**/*.visual-diff.js' -t 10000 -g some-pattern
 # update visual-diff goldens
-npx mocha './test/**/*.visual-diff.js' -t 10000 --require esm --golden
+npx mocha './test/**/*.visual-diff.js' -t 10000 --golden
 ```

package.json

 {
   "name": "@brightspace-ui/create",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Initializer for Brightspace web components",
@@ -5,0 +5,0 @@ "repository": "https://github.com/BrightspaceUI/create.git",

README.md

@@ -9,3 +9,3 @@ # @brightspace-ui/create
 
-Run the following command from the directory where the new component directory should be created (e.g., if desired end location is Documents/button, run from Documents). Github repo creation should be done separately and the steps there can be followed to add this new component to source control.
+Run the following command from the directory where the new component directory should be created (e.g., if desired end location is Documents/button, run from Documents). GitHub repo creation should be done separately and the steps there can be followed to add this new component to source control.
 
@@ -40,10 +40,10 @@ ```
 
-Visual diff results are published to a bucket in S3 and need special tokens to do so. To set these up, follow the instructions in the [visual-diff GitHub Action](https://github.com/BrightspaceUI/actions/tree/master/visual-diff).
+Visual diff results are published to a bucket in S3 and need special tokens to do so. To set these up, follow the instructions in the [visual-diff GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/visual-diff).
 
 ### Semantic Release
 
-In order for the release workflow to automatically update the version, you need to add brightspace-bot as an admin using the following steps:
+In order for the release workflow to automatically update the version, you need to add `brightspace-bot` as an admin using the following steps:
 Settings -> Manage access -> Invite teams or people -> Add brightspace-bot
 
-Learn more in the [action docs](https://github.com/BrightspaceUI/actions/blob/master/docs/branch-protection.md).
+Learn more in the [action docs](https://github.com/BrightspaceUI/actions/blob/main/docs/branch-protection.md).
 
@@ -54,4 +54,2 @@ ## Developing and Contributing
 * [ ] GitHub Actions integration for verify-translations
-* [ ] Switch to @web/dev-server
-* [ ] Switch to @web testing stuff
 
@@ -64,3 +62,3 @@ Pull requests welcome!
 
-The [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/master/semantic-release) is called from the `release.yml` GitHub Action workflow to handle version changes and releasing.
+The [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) is called from the `release.yml` GitHub Action workflow to handle version changes and releasing.
 
@@ -67,0 +65,0 @@ ### Version Changes

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

58824

decreased by-0.18%

Lines of code

577

decreased by-2.04%

Number of lines in readme file

93

decreased by-2.11%

No dependency changes