frontend-assessment-skill 1.0.0
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/LICENSE +21 -0
- package/README.md +106 -0
- package/bin/cli.js +109 -0
- package/package.json +38 -0
- package/skills/SKILL.md +260 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 DLN Roozemond
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# Frontend Assessment Skill
|
|
2
|
+
|
|
3
|
+
An installable AI Agent Skill for Zed, Claude, and other agent systems that produces a reproducible **1-100 frontend health and maturity assessment score** for any repository.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Run via `npx`:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx frontend-assessment-skill
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
The installer will prompt you to choose where to install the skill:
|
|
14
|
+
1. **Globally** (`~/.agents/skills/frontend-assessment`) — Available across all your projects in Zed / AI agents.
|
|
15
|
+
2. **Project folder** (`.agents/skills/frontend-assessment`) — Installed only in the current repository.
|
|
16
|
+
|
|
17
|
+
### Command-line flags (non-interactive)
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# Install globally
|
|
21
|
+
npx frontend-assessment-skill --global
|
|
22
|
+
|
|
23
|
+
# Install in current project directory
|
|
24
|
+
npx frontend-assessment-skill --project
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## How to Use
|
|
30
|
+
|
|
31
|
+
Once installed, simply ask your agent in Zed (or your agent tool of choice):
|
|
32
|
+
|
|
33
|
+
> *"Perform a frontend health assessment of this repository"*
|
|
34
|
+
|
|
35
|
+
Or specify quarters/scopes:
|
|
36
|
+
|
|
37
|
+
> *"Run a frontend assessment for Q3 2025 focusing on the web-app package"*
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## What It Evaluates
|
|
42
|
+
|
|
43
|
+
The skill calculates a strict, reproducible score (0–100) across 7 criteria:
|
|
44
|
+
|
|
45
|
+
| Criterion | Weight | Summary |
|
|
46
|
+
| --- | :---: | --- |
|
|
47
|
+
| **Dependency freshness** | 20 | Share of dependencies on latest/minor version and updated within 183 days |
|
|
48
|
+
| **Core package currency** | 20 | Currency of core runtime, framework, router, build, and test tools |
|
|
49
|
+
| **Contributor diversity** | 10 | Unique contributors in the last 12 months (diversity signal) |
|
|
50
|
+
| **Quarterly delivery cadence** | 10 | Commits, merges, and releases during the assessed quarter |
|
|
51
|
+
| **Test suite maturity** | 10 | Presence of unit, integration, component, and e2e test layers |
|
|
52
|
+
| **Coverage** | 10 | Frontend code test coverage percentage |
|
|
53
|
+
| **UI system & component library** | 20 | Adoption of a single consistent component library, formal design tokens, and non-deprecated UI dependencies |
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Development & Publishing
|
|
58
|
+
|
|
59
|
+
### 1. Local Testing
|
|
60
|
+
|
|
61
|
+
To test the CLI installer locally before publishing:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
# Test help output
|
|
65
|
+
node bin/cli.js --help
|
|
66
|
+
|
|
67
|
+
# Test interactive installation
|
|
68
|
+
node bin/cli.js
|
|
69
|
+
|
|
70
|
+
# Test npx invocation locally in the package root
|
|
71
|
+
npx .
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### 2. Versioning & Git Setup
|
|
75
|
+
|
|
76
|
+
Initialize your git repository and prepare a release:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
git init
|
|
80
|
+
git add .
|
|
81
|
+
git commit -m "Initial release of frontend-assessment-skill"
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### 3. Publishing to npm (via GitHub Actions)
|
|
85
|
+
|
|
86
|
+
This repository includes a GitHub Actions workflow (`.github/workflows/publish.yml`) that automatically publishes to npm when a GitHub Release is published, with support for npm provenance.
|
|
87
|
+
|
|
88
|
+
1. Create an **Access Token** on [npmjs.com](https://www.npmjs.com) (Automation token or Granular Access Token with Read and write access to packages).
|
|
89
|
+
2. Add it as a secret in your GitHub repository:
|
|
90
|
+
- Navigate to **Settings > Secrets and variables > Actions**
|
|
91
|
+
- Create a new repository secret named `NPM_TOKEN` with your npm token value.
|
|
92
|
+
3. To publish a release:
|
|
93
|
+
- Update `version` in `package.json` (e.g. `npm version patch`)
|
|
94
|
+
- Push commits and tags to GitHub
|
|
95
|
+
- Create and publish a new Release in GitHub (e.g. `v1.0.0`)
|
|
96
|
+
- The workflow will automatically publish the package with npm provenance enabled.
|
|
97
|
+
|
|
98
|
+
Alternatively, you can manually trigger the workflow from the **Actions** tab in GitHub.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## License & Attribution
|
|
103
|
+
|
|
104
|
+
This project is licensed under the [MIT License](./LICENSE) © 2025 DLN Roozemond.
|
|
105
|
+
|
|
106
|
+
You are free to use, modify, and distribute this skill. When redistributing or including this skill in other packages, attribution to **DLN Roozemond** is required as detailed in the `LICENSE`.
|
package/bin/cli.js
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
import fs from 'node:fs';
|
|
4
|
+
import path from 'node:path';
|
|
5
|
+
import os from 'node:os';
|
|
6
|
+
import readline from 'node:readline/promises';
|
|
7
|
+
import { fileURLToPath } from 'node:url';
|
|
8
|
+
|
|
9
|
+
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
10
|
+
const SKILL_NAME = 'frontend-assessment';
|
|
11
|
+
const SOURCE_SKILL_PATH = path.resolve(__dirname, '../skills/SKILL.md');
|
|
12
|
+
|
|
13
|
+
const args = process.argv.slice(2);
|
|
14
|
+
|
|
15
|
+
function printHelp() {
|
|
16
|
+
console.log(`
|
|
17
|
+
Frontend Assessment Skill Installer
|
|
18
|
+
|
|
19
|
+
Usage:
|
|
20
|
+
npx frontend-assessment-skill [options]
|
|
21
|
+
|
|
22
|
+
Options:
|
|
23
|
+
-g, --global Install globally to ~/.agents/skills/frontend-assessment
|
|
24
|
+
-p, --project Install locally to .agents/skills/frontend-assessment
|
|
25
|
+
-h, --help Show this help message
|
|
26
|
+
`);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
async function run() {
|
|
30
|
+
if (args.includes('-h') || args.includes('--help')) {
|
|
31
|
+
printHelp();
|
|
32
|
+
process.exit(0);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
if (!fs.existsSync(SOURCE_SKILL_PATH)) {
|
|
36
|
+
console.error(`\n❌ Error: Source skill file not found at ${SOURCE_SKILL_PATH}\n`);
|
|
37
|
+
process.exit(1);
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
console.log('\n=========================================');
|
|
41
|
+
console.log(' 📊 Frontend Assessment Skill Installer');
|
|
42
|
+
console.log('=========================================\n');
|
|
43
|
+
|
|
44
|
+
let targetScope = null;
|
|
45
|
+
|
|
46
|
+
if (args.includes('-g') || args.includes('--global')) {
|
|
47
|
+
targetScope = 'global';
|
|
48
|
+
} else if (args.includes('-p') || args.includes('--project')) {
|
|
49
|
+
targetScope = 'project';
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
const rl = readline.createInterface({
|
|
53
|
+
input: process.stdin,
|
|
54
|
+
output: process.stdout,
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
try {
|
|
58
|
+
if (!targetScope) {
|
|
59
|
+
console.log('Where would you like to install the skill?');
|
|
60
|
+
console.log(' 1) Globally (~/.agents/skills/frontend-assessment)');
|
|
61
|
+
console.log(' 2) In current project folder (.agents/skills/frontend-assessment)');
|
|
62
|
+
console.log(' 3) Cancel\n');
|
|
63
|
+
|
|
64
|
+
const answer = (await rl.question('Select an option (1-3) [default: 1]: ')).trim() || '1';
|
|
65
|
+
|
|
66
|
+
if (answer === '1') {
|
|
67
|
+
targetScope = 'global';
|
|
68
|
+
} else if (answer === '2') {
|
|
69
|
+
targetScope = 'project';
|
|
70
|
+
} else {
|
|
71
|
+
console.log('\nInstallation cancelled.\n');
|
|
72
|
+
process.exit(0);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
const targetDir =
|
|
77
|
+
targetScope === 'global'
|
|
78
|
+
? path.join(os.homedir(), '.agents', 'skills', SKILL_NAME)
|
|
79
|
+
: path.join(process.cwd(), '.agents', 'skills', SKILL_NAME);
|
|
80
|
+
|
|
81
|
+
const targetFile = path.join(targetDir, 'SKILL.md');
|
|
82
|
+
|
|
83
|
+
if (fs.existsSync(targetFile)) {
|
|
84
|
+
const overwrite = (
|
|
85
|
+
await rl.question(`\n⚠️ Skill already exists at:\n ${targetFile}\n Overwrite? (y/N): `)
|
|
86
|
+
).trim().toLowerCase();
|
|
87
|
+
|
|
88
|
+
if (overwrite !== 'y' && overwrite !== 'yes') {
|
|
89
|
+
console.log('\nInstallation cancelled. Existing file left untouched.\n');
|
|
90
|
+
process.exit(0);
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
fs.mkdirSync(targetDir, { recursive: true });
|
|
95
|
+
fs.copyFileSync(SOURCE_SKILL_PATH, targetFile);
|
|
96
|
+
|
|
97
|
+
console.log(`\n✅ Successfully installed "${SKILL_NAME}" skill!`);
|
|
98
|
+
console.log(` Location: ${targetFile}\n`);
|
|
99
|
+
console.log('You can now run frontend assessments in your AI agent (e.g. Zed, Claude) by prompting:');
|
|
100
|
+
console.log(' "Give me a frontend assessment of this repository"\n');
|
|
101
|
+
} catch (err) {
|
|
102
|
+
console.error('\n❌ Installation failed:', err.message, '\n');
|
|
103
|
+
process.exit(1);
|
|
104
|
+
} finally {
|
|
105
|
+
rl.close();
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
run();
|
package/package.json
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "frontend-assessment-skill",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Installer for the frontend-assessment agent skill (Zed, Claude, and agent tools)",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "bin/cli.js",
|
|
7
|
+
"bin": {
|
|
8
|
+
"frontend-assessment-skill": "./bin/cli.js",
|
|
9
|
+
"frontend-assessment": "./bin/cli.js"
|
|
10
|
+
},
|
|
11
|
+
"files": [
|
|
12
|
+
"bin",
|
|
13
|
+
"skills",
|
|
14
|
+
"LICENSE",
|
|
15
|
+
"README.md"
|
|
16
|
+
],
|
|
17
|
+
"keywords": [
|
|
18
|
+
"zed",
|
|
19
|
+
"agent-skills",
|
|
20
|
+
"skills",
|
|
21
|
+
"frontend",
|
|
22
|
+
"assessment",
|
|
23
|
+
"design-system",
|
|
24
|
+
"component-library"
|
|
25
|
+
],
|
|
26
|
+
"author": "Niels Roozemond <n.roozemond@amsterdam.nl>",
|
|
27
|
+
"license": "MIT",
|
|
28
|
+
"repository": {
|
|
29
|
+
"type": "git",
|
|
30
|
+
"url": "https://github.com/dlnr/frontend-assessment-skill.git"
|
|
31
|
+
},
|
|
32
|
+
"publishConfig": {
|
|
33
|
+
"access": "public"
|
|
34
|
+
},
|
|
35
|
+
"engines": {
|
|
36
|
+
"node": ">=18.0.0"
|
|
37
|
+
}
|
|
38
|
+
}
|
package/skills/SKILL.md
ADDED
|
@@ -0,0 +1,260 @@
|
|
|
1
|
+
---
|
|
2
|
+
|
|
3
|
+
name: frontend-assessment
|
|
4
|
+
|
|
5
|
+
description: Assess frontend health and maturity. USE WHEN the user asks for a "frontend assessment", "frontend health check", "frontend review", "frontend score", or wants a reproducible 1-100 score for dependency freshness, core package currency, contributor activity, delivery cadence, testing, coverage, and UI system & component library adoption.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Frontend Assessment
|
|
11
|
+
|
|
12
|
+
Produce a reproducible **1-100 frontend assessment score** for the current repository.
|
|
13
|
+
|
|
14
|
+
## User Instructions
|
|
15
|
+
|
|
16
|
+
$ARGUMENTS
|
|
17
|
+
|
|
18
|
+
Respect any explicit scope, quarter, or stack instructions from the user. If the user does not provide a quarter, assess the **most recently completed calendar quarter**.
|
|
19
|
+
|
|
20
|
+
## Goal
|
|
21
|
+
|
|
22
|
+
Measure frontend health in a way that is:
|
|
23
|
+
|
|
24
|
+
- **reproducible**: use the same rubric every time
|
|
25
|
+
- **stack-aware**: evaluate the frontend framework/runtime actually in use
|
|
26
|
+
- **evidence-based**: do not guess; cite repo evidence and command output
|
|
27
|
+
- **portable**: works for monorepos, single-app repos, and different frontend stacks
|
|
28
|
+
|
|
29
|
+
## Assessment Scope
|
|
30
|
+
|
|
31
|
+
1. Identify the frontend surface being assessed.
|
|
32
|
+
- In a monorepo, prefer the primary deployable frontend application(s).
|
|
33
|
+
- If the repo contains multiple frontend apps and the user did not narrow scope, assess the main production-facing app(s) plus shared frontend libraries used by them.
|
|
34
|
+
- State the scope explicitly in the report.
|
|
35
|
+
2. Detect the package manager from lockfiles and use the workspace-native tooling.
|
|
36
|
+
3. Prefer direct evidence from:
|
|
37
|
+
- `package.json` and relevant app/library manifests
|
|
38
|
+
- lockfiles
|
|
39
|
+
- build/test/project configuration
|
|
40
|
+
- git history
|
|
41
|
+
- GitHub releases / PR metadata
|
|
42
|
+
- UI system and design token package manifests & deprecation metadata
|
|
43
|
+
|
|
44
|
+
## Stack Detection
|
|
45
|
+
|
|
46
|
+
Detect the frontend stack first. Typical examples:
|
|
47
|
+
|
|
48
|
+
| Category | Candidate packages |
|
|
49
|
+
| --- | --- |
|
|
50
|
+
| UI runtime | `react`, `vue`, `angular`, `svelte` |
|
|
51
|
+
| App framework | `next`, `remix`, `@remix-run/*`, `gatsby`, `nuxt` |
|
|
52
|
+
| Router | `react-router`, `react-router-dom`, `@tanstack/router`, framework router |
|
|
53
|
+
| Build tool | `vite`, `webpack`, `rspack`, `parcel` |
|
|
54
|
+
| Test tools | `jest`, `vitest`, `cypress`, `playwright` |
|
|
55
|
+
| UI component library | `@mui/*`, `@chakra-ui/*`, `antd`, `@mantine/*`, `@radix-ui/*`, `shadcn` (`components.json`), `@carbon/*`, `@fluentui/*`, `react-bootstrap`, `@shoelace-style/*`, in-house/custom design system |
|
|
56
|
+
| Design tokens / Styling | `style-dictionary`, `@tokens-studio/*`, design token packages, `tailwindcss`, `@vanilla-extract/*`, `styled-components`, `@emotion/*`, CSS variables/theme tokens |
|
|
57
|
+
|
|
58
|
+
When a stack-specific package from the user's examples is not present, substitute the equivalent core package(s) for that stack.
|
|
59
|
+
|
|
60
|
+
## Data Collection
|
|
61
|
+
|
|
62
|
+
### 1. Dependency freshness
|
|
63
|
+
|
|
64
|
+
Assess direct dependencies that materially affect the frontend:
|
|
65
|
+
|
|
66
|
+
- production dependencies used by the frontend app(s)
|
|
67
|
+
- shared frontend libraries they consume
|
|
68
|
+
- dev dependencies only when they are frontend-critical (for example `vite`, `webpack`, `storybook`, `jest`, `vitest`, `playwright`, `cypress`)
|
|
69
|
+
|
|
70
|
+
Use existing package manager commands and registry metadata. Prefer:
|
|
71
|
+
|
|
72
|
+
- `npm outdated --json`
|
|
73
|
+
- `npm view <package> version time --json`
|
|
74
|
+
- lockfile/package manifest inspection
|
|
75
|
+
|
|
76
|
+
For each assessed package, determine:
|
|
77
|
+
|
|
78
|
+
- installed/resolved version
|
|
79
|
+
- latest published version
|
|
80
|
+
- publish date of installed/resolved version
|
|
81
|
+
- whether the package is behind latest major/minor/patch
|
|
82
|
+
|
|
83
|
+
### 2. Core package currency
|
|
84
|
+
|
|
85
|
+
Build a short list of core frontend packages for the detected stack. This should usually include:
|
|
86
|
+
|
|
87
|
+
- one runtime/framework package
|
|
88
|
+
- one router package if applicable
|
|
89
|
+
- one build tool package
|
|
90
|
+
- one test runner if the stack depends on it for core developer workflow
|
|
91
|
+
|
|
92
|
+
If a core package is not on the latest version, determine whether it is:
|
|
93
|
+
|
|
94
|
+
- intentionally blocked by a peer dependency or framework compatibility constraint
|
|
95
|
+
- simply behind with no clear blocker
|
|
96
|
+
|
|
97
|
+
Useful evidence sources:
|
|
98
|
+
|
|
99
|
+
- `npm view <package> peerDependencies --json`
|
|
100
|
+
- `npm ls <package>`
|
|
101
|
+
- framework/plugin package peer ranges
|
|
102
|
+
|
|
103
|
+
### 3. Contributor activity
|
|
104
|
+
|
|
105
|
+
Count unique contributors in the last 12 months from git history. Prefer:
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
git log --since="12 months ago" --format='%aN <%aE>' --all | sort -u
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Use the unique author list count as the metric. This is a diversity signal, not a popularity contest.
|
|
112
|
+
|
|
113
|
+
### 4. Quarterly delivery cadence
|
|
114
|
+
|
|
115
|
+
For the assessed quarter, count:
|
|
116
|
+
|
|
117
|
+
- commits
|
|
118
|
+
- merges
|
|
119
|
+
- releases
|
|
120
|
+
|
|
121
|
+
Prefer:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
git rev-list --count --since="<quarter-start>" --until="<quarter-end>" --all
|
|
125
|
+
git rev-list --count --merges --since="<quarter-start>" --until="<quarter-end>" --all
|
|
126
|
+
gh api repos/<owner>/<repo>/releases --paginate
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Use GitHub Releases where available. If there are no GitHub releases, record `0` and note if the repo appears to release by tags or another mechanism.
|
|
130
|
+
|
|
131
|
+
### 5. Test suites
|
|
132
|
+
|
|
133
|
+
Determine whether the application uses automated tests and which layers exist:
|
|
134
|
+
|
|
135
|
+
- unit
|
|
136
|
+
- integration
|
|
137
|
+
- component
|
|
138
|
+
- e2e
|
|
139
|
+
- visual/storybook checks
|
|
140
|
+
|
|
141
|
+
Use repo configuration and scripts first. Only run existing test commands when needed to discover coverage or confirm a configured test surface.
|
|
142
|
+
|
|
143
|
+
### 6. Coverage
|
|
144
|
+
|
|
145
|
+
Prefer existing coverage artifacts or CI/test configuration over inventing new instrumentation:
|
|
146
|
+
|
|
147
|
+
- `coverage/` directories
|
|
148
|
+
- CI settings
|
|
149
|
+
- `jest` / `vitest` / `nyc` / `cypress` coverage configuration
|
|
150
|
+
- existing `--coverage` scripts
|
|
151
|
+
|
|
152
|
+
If multiple coverage figures exist, report the most relevant frontend application coverage and note any additional figures.
|
|
153
|
+
|
|
154
|
+
### 7. UI system and component library
|
|
155
|
+
|
|
156
|
+
Inspect the project dependencies and source code to identify and assess:
|
|
157
|
+
|
|
158
|
+
- **Detected component libraries**: Name all UI component libraries in use (e.g. `@mui/*`, `antd`, `@chakra-ui/*`, `@mantine/*`, `@radix-ui/*`, `shadcn`, `@carbon/*`, `@fluentui/*`, `react-bootstrap`, in-house component library, etc.).
|
|
159
|
+
- **Detected design tokens / theme libraries**: Identify design token packages and formal theme tokens (e.g. `style-dictionary`, `@tokens-studio/*`, dedicated token packages, CSS variables/theme definitions).
|
|
160
|
+
- **Consistency**: Verify whether a **single component library** is used consistently across the application, or if multiple competing UI libraries are mixed.
|
|
161
|
+
- **Deprecation check**: Check if any detected UI library or token package is deprecated using `npm view <package> deprecated --json` or known deprecation status.
|
|
162
|
+
- **Adoption & version currency**: Evaluate if the component library and design system are actively used across the app and on supported versions.
|
|
163
|
+
|
|
164
|
+
## Scoring Rubric
|
|
165
|
+
|
|
166
|
+
Score each criterion independently and sum to **100**.
|
|
167
|
+
|
|
168
|
+
| Criterion | Weight | How to score |
|
|
169
|
+
| ----------------------------------- | -----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
170
|
+
| Dependency freshness | 20 | `score = round(20 * fresh_ratio)` where `fresh_ratio` is the share of assessed packages that are both on latest version **or** at most one minor behind **and** whose installed version is not older than 183 days. If a package has had no release in the last 183 days at all, treat it as neutral rather than stale if the installed version is latest. |
|
|
171
|
+
| Core package currency | 20 | `20` all core packages latest or latest compatible and blockers are documented; `15` only minor lag or documented peer/framework blockers; `8` one core package is one major behind without blocker; `0` multiple core packages are one major behind or any core package is more than one major behind without blocker. |
|
|
172
|
+
| Contributors, last 12 months | 10 | `10` >= 4 contributors; `8` 3 contributors; `6` 2 contributors; `3` 1 contributor; `0` 0 contributors. Cap at 10 so very large teams do not dominate the score. |
|
|
173
|
+
| Quarterly commits, merges, releases | 10 | Score three sub-parts and add them: commits `0-4` (`>=50` = 4, `20-49` = 3, `5-19` = 2, `1-4` = 1, `0` = 0), merges `0-3` (`>=15` = 3, `5-14` = 2, `1-4` = 1, `0` = 0), releases `0-3` (`>=2` = 3, `1` = 2, `0` = 0). |
|
|
174
|
+
| Test suite maturity | 10 | `10` unit plus integration/e2e/component coverage across meaningful app flows; `7` at least two test layers; `4` one automated test layer only; `0` no automated tests found. |
|
|
175
|
+
| Coverage | 10 | `10` >= 80%; `8` 70-79%; `6` 60-69%; `3` 40-59%; `1` 1-39%; `0` no measurable coverage found. Use the most relevant frontend coverage number, not backend-only coverage. |
|
|
176
|
+
| UI system & component library | 20 | `20` single modern component library used consistently across the app + formal design system & token library adoption, non-deprecated; `15` single component library used consistently with design tokens/theme system (minor version lag or isolated deviations); `10` single component library without formal tokens OR custom design system without token library; `5` mixed/competing component libraries (fragmented UI) OR deprecated library with migration underway; `0` deprecated/unmaintained UI library as primary UI, severe library fragmentation, or no component library/tokens. |
|
|
177
|
+
|
|
178
|
+
## Important Scoring Rules
|
|
179
|
+
|
|
180
|
+
1. **Do not make up evidence.**
|
|
181
|
+
2. **Do not average away major problems.** If a core package is badly outdated, reflect that sharply.
|
|
182
|
+
3. **Do not over-penalize stable packages** that are latest even if the ecosystem has been quiet for more than 6 months.
|
|
183
|
+
4. **Penalize deprecated and fragmented UI libraries.** Using deprecated UI packages or mixing multiple competing component libraries directly reduces the UI system score.
|
|
184
|
+
5. **Reward consistent single component library and design token usage.** Full points require a single unified component library paired with a design system and token library.
|
|
185
|
+
6. **Keep the rubric fixed.** If you must diverge, explain exactly why.
|
|
186
|
+
7. **Factor in when calculating the score** the age of the repository, complexity and number of developers active in the repo.
|
|
187
|
+
|
|
188
|
+
## Required Output
|
|
189
|
+
|
|
190
|
+
Return the assessment in this structure:
|
|
191
|
+
|
|
192
|
+
### Scope
|
|
193
|
+
|
|
194
|
+
- repository / app(s) assessed
|
|
195
|
+
- quarter assessed
|
|
196
|
+
- detected stack
|
|
197
|
+
- detected UI system & component library: `<names of detected libraries or "None">`
|
|
198
|
+
- detected design tokens / theme library: `<names of detected token packages or "None">`
|
|
199
|
+
|
|
200
|
+
### Score summary
|
|
201
|
+
|
|
202
|
+
`Frontend assessment score: <total>/100`
|
|
203
|
+
|
|
204
|
+
### Scoring table
|
|
205
|
+
|
|
206
|
+
| Criterion | Weight | Evidence | Score | Notes |
|
|
207
|
+
| --- | ---: | --- | ---: | --- |
|
|
208
|
+
| Dependency freshness | 20 | ... | ... | ... |
|
|
209
|
+
| Core package currency | 20 | ... | ... | ... |
|
|
210
|
+
| Contributors, last 12 months | 10 | ... | ... | ... |
|
|
211
|
+
| Quarterly commits, merges, releases | 10 | ... | ... | ... |
|
|
212
|
+
| Test suite maturity | 10 | ... | ... | ... |
|
|
213
|
+
| Coverage | 10 | ... | ... | ... |
|
|
214
|
+
| UI system & component library | 20 | ... (Names of used component libraries & token libraries, consistency status, and deprecation status) | ... | ... |
|
|
215
|
+
| **Total** | **100** | | **<total>** | |
|
|
216
|
+
|
|
217
|
+
### UI system & component library status
|
|
218
|
+
|
|
219
|
+
Include a breakdown of detected UI and design token packages:
|
|
220
|
+
|
|
221
|
+
| Library / Package | Role (Component library / Tokens / Styling) | Installed version | Latest version | Deprecated? | Consistency & Notes |
|
|
222
|
+
| --- | --- | --- | --- | --- | --- |
|
|
223
|
+
|
|
224
|
+
### Core package status
|
|
225
|
+
|
|
226
|
+
Include a compact table for the detected core packages:
|
|
227
|
+
|
|
228
|
+
| Package | Current | Latest | Status | Blocked by dependency? |
|
|
229
|
+
| --- | --- | --- | --- | --- |
|
|
230
|
+
|
|
231
|
+
### Top 10 pros and cons
|
|
232
|
+
|
|
233
|
+
Use exactly 10 ranked rows:
|
|
234
|
+
|
|
235
|
+
| Rank | Pro | Con |
|
|
236
|
+
| ---: | --- | --- |
|
|
237
|
+
| 1 | ... | ... |
|
|
238
|
+
| 2 | ... | ... |
|
|
239
|
+
| 3 | ... | ... |
|
|
240
|
+
| 4 | ... | ... |
|
|
241
|
+
| 5 | ... | ... |
|
|
242
|
+
| 6 | ... | ... |
|
|
243
|
+
| 7 | ... | ... |
|
|
244
|
+
| 8 | ... | ... |
|
|
245
|
+
| 9 | ... | ... |
|
|
246
|
+
| 10 | ... | ... |
|
|
247
|
+
|
|
248
|
+
### Verdict
|
|
249
|
+
|
|
250
|
+
End with:
|
|
251
|
+
|
|
252
|
+
- one short paragraph explaining what drove the score
|
|
253
|
+
- one short paragraph naming the highest-leverage improvements
|
|
254
|
+
|
|
255
|
+
## Behavior Notes
|
|
256
|
+
|
|
257
|
+
- Prefer repository-native commands and existing CI/test scripts.
|
|
258
|
+
- Do not install new tooling just to produce the assessment.
|
|
259
|
+
- For Nx workspaces, use `npm nx` / `npx nx` and existing targets rather than bypassing Nx.
|
|
260
|
+
- Keep the result concise, but include enough evidence that another reviewer can reproduce the score.
|