@forgerock/ui-design - npm Package Compare versions

Comparing version 0.0.15 to 0.1.0

package.json

 {
   "name": "@forgerock/ui-design",
-  "version": "0.0.15",
+  "version": "0.1.0",
   "description": "ForgeRock Styles and Styleguide",
   "files": [
-    "styleguide/src/assets",
-    "styleguide/_site/src/assets/css",
-    "src/scss/abstracts/img"
+    "lib/",
+    "src/"
   ],
-  "main": "./styleguide/_site/src/assets/css/style.css",
+  "main": "./lib/forgerock.css",
   "scripts": {
-    "sprite": "svg-sprite -cD ./src/scss/ --cscss --css-dest abstracts --css-render-scss-dest _sprite.scss --css-sprite img/sprite.svg --css-render-scss-template ./src/svg/tpl/sprite.scss ./src/svg/*.svg",
-    "serve": "cd styleguide && jekyll serve"
+    "build": "npm-run-all -s lint -p clean build:sprite build:sass build:types",
+    "build:sass": "build/build.js",
+    "build:sprite": "svg-sprite -cD ./ --cscss --css-dest src/scss/ --css-render-scss-dest _sprite.scss --css-sprite sprites/sprite.svg --css-render-scss-template src/svg/tpl/sprite.scss ./src/svg/*.svg",
+    "build:types": "tcm lib/ -c",
+    "clean": "rimraf dist/*",
+    "lint": "stylelint \"src/scss/**/*\"",
+    "lint:fix": "stylelint \"src/scss/**/*\" --fix",
+    "watch:all": "npm-run-all --parallel watch:sass watch:sprite watch:types",
+    "watch:sass": "onchange -i 'src/scss/**/*.scss' -- npm-run-all build:sass",
+    "watch:sprite": "onchange -i 'src/svg/**/*' -- npm-run-all build:sprite",
+    "watch:types": "onchange 'lib/**/*.css' -- npm-run-all build:types"
   },
@@ -19,3 +27,3 @@ "repository": {
   },
-  "author": "",
+  "author": "FRAAS Engineering",
   "license": "ISC",
@@ -26,8 +34,22 @@ "bugs": {
   "homepage": "https://github.com/ForgeRock/ui-design#readme",
-  "dependencies": {
+  "style": "lib/forgerock.css",
+  "devDependencies": {
+    "bootstrap": "^4.3.1",
+    "node-sass": "^4.12.0",
+    "npm-run-all": "^4.1.5",
+    "onchange": "^6.1.0",
+    "prettier": "^1.18.2",
+    "rimraf": "^3.0.0",
+    "sass": "^1.22.12",
+    "stylelint": "^11.0.0",
+    "stylelint-config-prettier": "^6.0.0",
+    "stylelint-prettier": "^1.1.1",
+    "stylelint-scss": "^3.11.1",
+    "svg-sprite": "^1.5.0",
     "typed-css-modules": "^0.6.2"
   },
-  "devDependencies": {
-    "svg-sprite": "^1.5.0"
+  "dependencies": {
+    "lib": "^4.0.5",
+    "stylelint-config-standard": "^19.0.0"
   }
 }

README.md

 # UI Design
 
-Jekyll Styleguide
-`stylguide/`
+The ForgeRock UI Design package is a CSS library built on top of Bootstrap. All existing Bootstrap
+styles and class names are unchanged, and this library should be used as if it were the original
+Bootstrap library.
+
+## Usage as a package
+
+### Installation
+
+`$ npm install @forgerock/ui-design`
+
+### CSS, Source Map, TypeDef files
+
+The main `forgerock.css` file is located in the `lib/` folder along with a CSS sourcemap and
+TypeScript type definitions file
+
+```
+forgerock.css
+forgerock.css.map
+forgerock.css.d.ts
+```
+
+### Spritesheet
+
+The spritesheet SVG file will be located in `src/scss/sprites` and will have a css-busting unqiue filename with
+each build.
+
+```
+sprite-#####.svg
+```
+
+## Building & Developing
+
+### Complete Package
+
+Running this script will automatically build the complete SCSS library. The build process includes
+linting, building spritesheet, and creating type definitions. Compiled files are located in the
+`lib` folder.
+
+```
+$ npm run build
+```
+
+### Sass
+
+Running this script will build the complete SCSS library, or individual components depending on
+passed arguments. Arguments are passed to an npm script via the `--` delimeter. Compiled CSS files
+are located in the `dist` folder.
+
+##### All components
+
+Outputted filename will be `forgerock.css`
+
+```
+$ npm run build:sass
+```
+
+##### Specific components
+
+Outputted filename will be `component1-component2-etc.css` ex: `alert-badge-card.css`
+
+```
+$ npm run build:sass -- alert badge card
+```
+
+### Sprites
+
+To update the sprite library, add your svg to the `src/svg/` folder and run the below script. This
+will render a new PNG spritesheet in the `src/svg/sprites/` folder, and the SASS file
+`src/scss/_sprite.scss`.
+
+```
+$ npm run build:sprites
+```
+
+### Type Definitions
+
+Running this script will build type definitions for the main CSS file located in the `lib` folder.
+
+```
+$ npm run build:types
+```

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

Improved metrics

Number of low maintenance alerts

2

decreased by-33.33%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

84

increased by1580%

Worsened metrics

Total package byte prevSize

566940

decreased by-95.19%

Dependency count

2

increased by100%

Dev dependency count

13

increased by1200%

Number of package files

61

decreased by-68.56%

Lines of code

2333

decreased by-18.6%

Dependency changes

• + Addedlib@^4.0.5

• + Addedstylelint-config-standard@^19.0.0

• + Added@babel/code-frame@7.26.2(transitive)

• + Added@babel/helper-validator-identifier@7.25.9(transitive)

• + Added@csstools/css-parser-algorithms@3.0.4(transitive)

• + Added@csstools/css-tokenizer@3.0.3(transitive)

• + Added@csstools/selector-specificity@5.0.0(transitive)

• + Added@dual-bundle/import-meta-resolve@4.1.0(transitive)

• + Added@keyv/serialize@1.0.2(transitive)

• + Added@nodelib/fs.scandir@2.1.5(transitive)

• + Added@nodelib/fs.stat@2.0.5(transitive)

• + Added@nodelib/fs.walk@1.2.8(transitive)

• + Addedajv@8.17.1(transitive)

• + Addedargparse@2.0.1(transitive)

• + Addedarray-union@2.1.0(transitive)

• + Addedastral-regex@2.0.0(transitive)

• + Addedbalanced-match@2.0.0(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbuffer@6.0.3(transitive)

• + Addedcacheable@1.8.8(transitive)

• + Addedcallsites@3.1.0(transitive)

• + Addedcolord@2.9.3(transitive)

• + Addedcosmiconfig@9.0.0(transitive)

• + Addedcss-functions-list@3.2.3(transitive)

• + Addedcss-tree@3.1.0(transitive)

• + Addeddebug@4.4.0(transitive)

• + Addeddir-glob@3.0.1(transitive)

• + Addedenv-paths@2.2.1(transitive)

• + Addederror-ex@1.3.2(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-glob@3.3.3(transitive)

• + Addedfast-uri@3.0.6(transitive)

• + Addedfastest-levenshtein@1.0.16(transitive)

• + Addedfastq@1.19.0(transitive)

• + Addedfile-entry-cache@10.0.6(transitive)

• + Addedflat-cache@6.1.6(transitive)

• + Addedflatted@3.3.2(transitive)

• + Addedglobal-modules@2.0.0(transitive)

• + Addedglobal-prefix@3.0.0(transitive)

• + Addedglobby@11.1.0(transitive)

• + Addedglobjoin@0.1.4(transitive)

• + Addedhas-flag@4.0.0(transitive)

• + Addedhookified@1.7.0(transitive)

• + Addedhtml-tags@3.3.1(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedignore@5.3.27.0.3(transitive)

• + Addedimport-fresh@3.3.1(transitive)

• + Addedimurmurhash@0.1.4(transitive)

• + Addedini@1.3.8(transitive)

• + Addedis-arrayish@0.2.1(transitive)

• + Addedis-plain-object@5.0.0(transitive)

• + Addedisexe@2.0.0(transitive)

• + Addedjs-tokens@4.0.0(transitive)

• + Addedjs-yaml@4.1.0(transitive)

• + Addedjson-parse-even-better-errors@2.3.1(transitive)

• + Addedjson-schema-traverse@1.0.0(transitive)

• + Addedkeyv@5.2.3(transitive)

• + Addedkind-of@6.0.3(transitive)

• + Addedknown-css-properties@0.35.0(transitive)

• + Addedlib@4.3.3(transitive)

• + Addedlines-and-columns@1.2.4(transitive)

• + Addedlodash.truncate@4.4.2(transitive)

• + Addedmathml-tag-names@2.1.3(transitive)

• + Addedmdn-data@2.12.2(transitive)

• + Addedmeow@13.2.0(transitive)

• + Addedmerge2@1.4.1(transitive)

• + Addedmicromatch@4.0.8(transitive)

• + Addedms@2.1.3(transitive)

• + Addednanoid@3.3.8(transitive)

• + Addedparent-module@1.0.1(transitive)

• + Addedparse-json@5.2.0(transitive)

• + Addedpath-type@4.0.0(transitive)

• + Addedpicocolors@1.1.1(transitive)

• + Addedpostcss@8.5.1(transitive)

• + Addedpostcss-resolve-nested-selector@0.1.6(transitive)

• + Addedpostcss-safe-parser@7.0.1(transitive)

• + Addedpostcss-selector-parser@7.1.0(transitive)

• + Addedpostcss-value-parser@4.2.0(transitive)

• + Addedqueue-microtask@1.2.3(transitive)

• + Addedrequire-from-string@2.0.2(transitive)

• + Addedresolve-from@4.0.05.0.0(transitive)

• + Addedreusify@1.0.4(transitive)

• + Addedrun-parallel@1.2.0(transitive)

• + Addedsignal-exit@4.1.0(transitive)

• + Addedslash@3.0.0(transitive)

• + Addedslice-ansi@4.0.0(transitive)

• + Addedsource-map-js@1.2.1(transitive)

• + Addedstylelint@16.14.1(transitive)

• + Addedstylelint-config-recommended@3.0.0(transitive)

• + Addedstylelint-config-standard@19.0.0(transitive)

• + Addedsupports-color@7.2.0(transitive)

• + Addedsupports-hyperlinks@3.2.0(transitive)

• + Addedsvg-tags@1.0.0(transitive)

• + Addedtable@6.9.0(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedwhich@1.3.1(transitive)

• + Addedwrite-file-atomic@5.0.1(transitive)

• - Removedtyped-css-modules@^0.6.2

• - Removed@types/css-modules-loader-core@1.1.4(transitive)

• - Removedansi-regex@2.1.1(transitive)

• - Removedansi-styles@2.2.13.2.1(transitive)

• - Removedanymatch@3.1.3(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbinary-extensions@2.3.0(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedcamelcase@5.3.1(transitive)

• - Removedchalk@1.1.32.4.2(transitive)

• - Removedchokidar@3.6.0(transitive)

• - Removedcliui@6.0.0(transitive)

• - Removedcolor-convert@1.9.3(transitive)

• - Removedcolor-name@1.1.3(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removedcss-modules-loader-core@1.1.0(transitive)

• - Removedcss-selector-tokenizer@0.7.3(transitive)

• - Removeddecamelize@1.2.0(transitive)

• - Removedescape-string-regexp@1.0.5(transitive)

• - Removedfastparse@1.1.2(transitive)

• - Removedfind-up@4.1.0(transitive)

• - Removedfs.realpath@1.0.0(transitive)

• - Removedfsevents@2.3.3(transitive)

• - Removedget-caller-file@2.0.5(transitive)

• - Removedglob@7.2.3(transitive)

• - Removedhas-ansi@2.0.0(transitive)

• - Removedhas-flag@1.0.03.0.0(transitive)

• - Removedicss-replace-symbols@1.1.0(transitive)

• - Removedinflight@1.0.6(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedis-binary-path@2.1.0(transitive)

• - Removedis-there@4.5.1(transitive)

• - Removedlocate-path@5.0.0(transitive)

• - Removedminimatch@3.1.2(transitive)

• - Removedminimist@1.2.8(transitive)

• - Removedmkdirp@0.5.6(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedp-limit@2.3.0(transitive)

• - Removedp-locate@4.1.0(transitive)

• - Removedp-try@2.2.0(transitive)

• - Removedpath-exists@4.0.0(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedpicocolors@0.2.1(transitive)

• - Removedpostcss@6.0.16.0.237.0.39(transitive)

• - Removedpostcss-modules-extract-imports@1.1.0(transitive)

• - Removedpostcss-modules-local-by-default@1.2.0(transitive)

• - Removedpostcss-modules-scope@1.1.0(transitive)

• - Removedpostcss-modules-values@1.3.0(transitive)

• - Removedreaddirp@3.6.0(transitive)

• - Removedrequire-directory@2.1.1(transitive)

• - Removedrequire-main-filename@2.0.0(transitive)

• - Removedset-blocking@2.0.0(transitive)

• - Removedsource-map@0.5.70.6.1(transitive)

• - Removedstrip-ansi@3.0.1(transitive)

• - Removedsupports-color@2.0.03.2.35.5.0(transitive)

• - Removedtyped-css-modules@0.6.8(transitive)

• - Removedwhich-module@2.0.1(transitive)

• - Removedwrap-ansi@6.2.0(transitive)

• - Removedwrappy@1.0.2(transitive)

• - Removedy18n@4.0.3(transitive)

• - Removedyargs@15.4.1(transitive)

• - Removedyargs-parser@18.1.3(transitive)