feat: Add script to check if packages pass publint (#523)

* Add zod schemas for CI validation

* Require npm field for components.json

* Remove svelte-layout-resizable

* Stricter Zod validation

* Stricter repository field validation

* Implement requested changes

* Add back accidentally removed field

* Move SvelteStore to templates.json

* Update category and tags

* Add script to get npm data

* Add script to get publint data

* Re-run updateNpm.js

* Re-run updatePublint.js

* Implement initial feedback

* Use npm.json data

* Update npm.js

* Switch async/await to then/catch

Co-authored-by: MacFJA <[email protected]>

* Fix prettier

* Run script

* Re-run updateNpm

* Also read tools.json

* Add @types/node

* Restructure npm.json output

* Fix updatePublint.js

* Display last update on components page

* Add to weekly workflow

* Clarify updating npm data

* Update src/lib/utils/injectNpmData.ts

Co-authored-by: MacFJA <[email protected]>

* Smaller date font, add version

* Improve error text

* Fix property title

* Move json to lib/data directory

* Fix npm.json path

* Also check tools.json

* Add to automated PR

* Add injectPublintData function

* Update publint

---------

Co-authored-by: MacFJA <[email protected]>

.github/workflows/fetch-latest-data.yml

@@ -25,15 +25,17 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
       - name: Update npm data
         run: node scripts/updateNpm.js
+      - name: Update publint data
+        run: node scripts/updatePublint.js
       - name: Run format
         run: pnpm run format
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v5
         with:
           commit-message: "(AUTO) Update data"
           title: "🤖 Update data"
-          body: Automatically fetch latest data from NPM, GitHub and GitLab
+          body: Automatically fetch latest data from GitHub, GitLab, NPM and Publint.
           branch: ci-update-data
-          add-paths: src/lib/data/npm.json,src/lib/data/stars.json
+          add-paths: src/lib/data/npm.json,src/lib/data/publint.json,src/lib/data/stars.json
           delete-branch: true
           token: ${{ secrets.GITHUB_TOKEN }}

package.json

@@ -30,12 +30,15 @@
 		"eslint": "^8.56.0",
 		"eslint-config-prettier": "^9.1.0",
 		"eslint-plugin-svelte": "^2.35.1",
+		"get-npm-tarball-url": "^2.1.0",
 		"highlight.js": "^11.9.0",
 		"itemsjs": "^2.1.24",
 		"mdsvex": "^0.11.0",
 		"package-name-regex": "^3.1.1",
+		"pako": "^2.1.0",
 		"prettier": "^3.1.1",
 		"prettier-plugin-svelte": "^3.1.2",
+		"publint": "^0.2.6",
 		"rehype-slug": "^6.0.0",
 		"svelte": "^4.2.8",
 		"svelte-check": "^3.6.2",

scripts/tarball.js

@@ -0,0 +1,44 @@
+// @ts-check
+// Source: https://github.com/bluwy/publint/blob/master/site/src/utils/tarball.js
+
+/** @typedef {{ name: string, buffer: ArrayBuffer }} TarballFile */
+
+/**
+ * @param {TarballFile[]} files
+ * @return {import('publint').Vfs}
+ * */
+export function createTarballVfs(files) {
+	return {
+		getDirName: (path) => path.replace(/\/[^/]*$/, ''),
+		getExtName: (path) => path.replace(/^.*\./, '.'),
+		isPathDir: async (path) => {
+			path = path.endsWith('/') ? path : path + '/';
+			return files.some((file) => file.name.startsWith(path));
+		},
+		isPathExist: async (path) => {
+			const pathDirVariant = path.endsWith('/') ? path : path + '/';
+			return files.some((file) => file.name === path || file.name.startsWith(pathDirVariant));
+		},
+		pathJoin: (...parts) =>
+			parts
+				.map((v) => (v.startsWith('./') ? v.slice(2) : v))
+				.join('/')
+				.replace('///', '/')
+				.replace('//', '/'), // TODO: optimize this please
+		pathRelative: (from, to) => to.replace(from, '').slice(1),
+		readDir: async (path) => {
+			path = path.endsWith('/') ? path : path + '/';
+			return files
+				.filter((file) => file.name.startsWith(path) && file.name !== path)
+				.map((file) => file.name.slice(path.length));
+		},
+		readFile: async (path) => {
+			const file = files.find((file) => file.name === path);
+			if (file) {
+				return new TextDecoder('utf-8').decode(file.buffer);
+			} else {
+				throw new Error(`Unable to read file at path: ${path}`);
+			}
+		}
+	};
+}