@trimble-oss/modus-docs-hugo-theme - npm Package Compare versions

Comparing version 1.0.0-alpha1 to 1.0.0-alpha2

assets/js/theme-toggle.js

@@ -0,1 +1,2 @@
+// script adapted from Adam Argyle's tutorial: https://web.dev/building-a-theme-switch-component/
 (() => {
@@ -2,0 +3,0 @@ 'use strict';

package.json

 {
   "name": "@trimble-oss/modus-docs-hugo-theme",
-  "version": "1.0.0-alpha1",
-  "description": "A Documentation heme for Hugo built by Trimble",
+  "version": "1.0.0-alpha2",
+  "description": "A Documentation theme for Hugo built by Trimble",
   "homepage": "https://github.com/trimble-oss/modus-docs-hugo-theme",
@@ -13,13 +13,15 @@ "bugs": {
   },
-  "license": "private",
+  "license": "MIT",
   "author": "Trimble",
   "scripts": {
     "build": "npx hugo",
-    "lint": "npm run lint-css && npm run lint-html",
+    "lint": "npm run lint-css && npm run lint-html && npm run lint-js",
     "lint-css": "stylelint \"assets/styles/*.*\" --fix",
     "lint-html": "htmlhint \"build/**/index.html\"",
+    "lint-js": "eslint assets/js/*.js --fix",
+    "lint-links": "npx linkinator content/ --recurse --silent --skip \"^(?!http://localhost)\"",
     "lint-spellcheck": "npx cspell \"content/**/*.md\" --no-progress",
     "prettier": "prettier --write \"**/*.{json,js,md,svg}\"",
     "serve": "hugo serve --port 4000 --disableFastRender --navigateToChanged",
-    "test": "npm run lint-css && npm run lint-html"
+    "test": "npm run lint-css && npm run lint-html && npm run lint-js"
   },
@@ -31,2 +33,4 @@ "dependencies": {
     "autoprefixer": "10.4.15",
+    "eslint": "^8.47.0",
+    "eslint-config-prettier": "^9.0.0",
     "htmlhint": "1.1.4",
@@ -37,3 +41,3 @@ "hugo-bin": "0.113.0",
     "prettier": "3.0.2",
-    "stylelint": "15.10.2",
+    "stylelint": "15.10.3",
     "stylelint-config-standard-scss": "10.0.0"
@@ -40,0 +44,0 @@ },

README.md

@@ -11,8 +11,4 @@ # Modus Docs Hugo Theme (Experimental)
 
-```json
-{
-  "dependencies": {
-    "modus-docs-hugo-theme": "git+github.com:trimble-oss/modus-docs-hugo-theme.git"
-  }
-}
+```bash
+npm i @trimble-oss/modus-docs-hugo-theme --save-dev
 ```
@@ -19,0 +15,0 @@

static/js/theme-toggle.js

@@ -13,6 +13,3 @@ // script adapted from Adam Argyle's tutorial: https://web.dev/building-a-theme-switch-component/
   if (localStorage.getItem(storageKey)) return localStorage.getItem(storageKey);
-  else
-    return window.matchMedia('(prefers-color-scheme: dark)').matches
-      ? 'dark'
-      : 'light';
+  else return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
 };
@@ -28,5 +25,3 @@
 
-  document
-    .querySelector('#theme-toggle')
-    ?.setAttribute('aria-label', theme.value);
+  document.querySelector('#theme-toggle')?.setAttribute('aria-label', theme.value);
 };
@@ -45,7 +40,5 @@
 
-window
-  .matchMedia('(prefers-color-scheme: dark)')
-  .addEventListener('change', ({ matches: isDark }) => {
-    theme.value = isDark ? 'dark' : 'light';
-    setPreference();
-  });
+window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', ({ matches: isDark }) => {
+  theme.value = isDark ? 'dark' : 'light';
+  setPreference();
+});

Fixed alerts

Misc. License Issues

License

(Experimental) A package's licensing information has fine-grained problems.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

458399

increased by0.07%

Number of medium license alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

10

increased by25%

Lines of code

248

decreased by-2.36%

Number of lines in readme file

40

decreased by-9.09%

No dependency changes