@deslop/coding-standards 0.1.1061 → 0.1.1063
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/dist/install.js +1 -1
- package/package.json +1 -1
- package/skills/design/SKILL.md +10 -7
- package/skills/engineering/SKILL.md +1 -1
package/dist/install.js
CHANGED
|
@@ -25233,7 +25233,7 @@ const runWith = (command, config) => {
|
|
|
25233
25233
|
};
|
|
25234
25234
|
//#endregion
|
|
25235
25235
|
//#region package.json
|
|
25236
|
-
var version = "0.1.
|
|
25236
|
+
var version = "0.1.1063";
|
|
25237
25237
|
//#endregion
|
|
25238
25238
|
//#region src/install.ts
|
|
25239
25239
|
const cli = pipe(make("deslop-coding-standards", {}, fnUntraced(function* () {
|
package/package.json
CHANGED
package/skills/design/SKILL.md
CHANGED
|
@@ -80,12 +80,13 @@ The first draft the user sees is already the refined one. Work through these ste
|
|
|
80
80
|
- The URL holds navigation state, and Back restores the scroll position and the draft.
|
|
81
81
|
- Place an error beside its field and move focus to the first one. Undo or confirm a destructive action.
|
|
82
82
|
- When the app already knows an action is not allowed, disable it and show the reason beside it.
|
|
83
|
+
- Selecting "All" clears the filter; never store or show "All" as one more filter value.
|
|
83
84
|
|
|
84
85
|
**States and speed.** A loading state has the layout of the loaded content, and a loader waits before it appears. Use stale-while-revalidate for cached data. Apply writes optimistically and roll back on failure without losing the person's place. Start unavoidable work early, and add no artificial wait. Errors and rare states get the same care as the main path.
|
|
85
86
|
|
|
86
87
|
**Copy.** Name actions after the person's task, with one vocabulary and sentence case. An empty state offers the next action. An error names what failed and the recovery that exists, beside its control.
|
|
87
88
|
|
|
88
|
-
**Motion.** Motion explains a change
|
|
89
|
+
**Motion.** Motion explains a state change or a spatial relationship: plan its trigger, source and destination with the interaction. It never delays input or decorates.
|
|
89
90
|
|
|
90
91
|
- Frequent actions and typing get no animation. Keep tweens under 300 ms, ease-out for entrances and ease-in-out for morphs. Interface springs start at a 0.4 second duration with 0.15 bounce.
|
|
91
92
|
- An entrance starts near its resting size, from 0.9 scale or more. A surface anchored to a trigger enters and exits from it.
|
|
@@ -97,11 +98,11 @@ The first draft the user sees is already the refined one. Work through these ste
|
|
|
97
98
|
|
|
98
99
|
## Prototype and tune
|
|
99
100
|
|
|
100
|
-
**Variants.** When
|
|
101
|
+
**Variants.** When layout or interaction has real alternatives, build an interactive render before product code: two or three variants on the same data, each clickable through every state from the States step. Give the page a variant switch and a grouped state selector that the phone can use. Fill it with realistic mock data, and draw it as close as possible to the code you will write: the app's tokens, components, copy and behavior. For a native app the render settles structure, flow and states; settle the final look in simulator captures. Label each variant with its one difference and mark your recommendation.
|
|
101
102
|
|
|
102
103
|
**Real host.** Build one representative screen with realistic data in the real host: the browser preview for the web, the simulator for a native app. An HTML imitation of a native screen misleads.
|
|
103
104
|
|
|
104
|
-
**Tune.** Settle values yourself
|
|
105
|
+
**Tune.** Settle values yourself. For values you cannot settle by reasoning, such as spacing, timing, springs or blur, capture candidates side by side, including both extremes, and judge them against the reference. Write the chosen values into the source and recapture.
|
|
105
106
|
|
|
106
107
|
## Critique before showing
|
|
107
108
|
|
|
@@ -131,10 +132,11 @@ Ground the page in its subject: name the audience and the page's one job, and ta
|
|
|
131
132
|
|
|
132
133
|
## Visual explanations
|
|
133
134
|
|
|
134
|
-
These rules cover diagrams, review pages and rendered agent answers; the reply decides when it needs a render. A render adds spatial or interactive information and replaces the text it shows; it never redraws prose, a file list or a fake runtime screenshot.
|
|
135
|
+
These rules cover diagrams, review pages and rendered agent answers; the reply decides when it needs a render. A render adds spatial or interactive information and replaces the text it shows; it never redraws prose, a file list, a check table or a fake runtime screenshot.
|
|
135
136
|
|
|
136
137
|
| The reader asks | Exhibit |
|
|
137
138
|
| ------------------------------------ | ------------------------------------------------------------- |
|
|
139
|
+
| What does it look like now? | State map of the changed system, changed parts marked |
|
|
138
140
|
| What changed on screen? | Before and after pair with the same data, the old state left |
|
|
139
141
|
| Which transitions are allowed? | State machine with forbidden edges marked |
|
|
140
142
|
| What happens in order, and who acts? | Sequence in swimlanes, one lane per actor |
|
|
@@ -149,8 +151,9 @@ These rules cover diagrams, review pages and rendered agent answers; the reply d
|
|
|
149
151
|
When none fits, choose the form that matches the data's shape; draw a list as a list.
|
|
150
152
|
|
|
151
153
|
- **One message.** Each page answers one question, and its first line states the conclusion, such as "The catalog loads 26 times faster".
|
|
152
|
-
- **One dominant element.** Size, weight and position show importance; mute the context.
|
|
154
|
+
- **One dominant element.** Size, weight and position show importance; mute the context. Show at most six labeled elements; never a text table, a collapsed card or a filter chip.
|
|
155
|
+
- **Honest scale.** Bars start at zero on one linear scale; draw a range as a range.
|
|
153
156
|
- **Labels.** Put names, values and units on the data, with one scale per comparison. Labels and captions stay under twelve words, and a visual holds no paragraphs.
|
|
154
157
|
- **Real content.** Use real names, numbers and captures, and show the scope.
|
|
155
|
-
- **Interaction.**
|
|
156
|
-
- **Check.** Use the host's theme variables, check light, dark and
|
|
158
|
+
- **Interaction.** When side-by-side options or captures turn unreadable at phone width, show them at one position behind labeled tabs. The conclusion stays visible without a tap.
|
|
159
|
+
- **Check.** Use the host's theme variables, check light, dark and a 390-point width, and fix clipping, overlap and contrast before you show it. At that width the page stays under about 400 points tall.
|
|
@@ -3,7 +3,7 @@ name: engineering
|
|
|
3
3
|
description: 'TypeScript and Effect code conventions paired with shared lint. Use when designing, implementing or reviewing product and test code, including prototypes.'
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
**Scope.** Apply these rules and the repository's `CODING_STANDARDS.md`, and write each line right the first time; lint is only the fallback. A refactor or cleanup request applies every rule to every line of the owned files.
|
|
6
|
+
**Scope.** Apply these rules and the repository's `CODING_STANDARDS.md`, and write each line right the first time; lint is only the fallback. A refactor or cleanup request applies every rule to every line of the owned files. Scratch code outside the repository follows no style rule.
|
|
7
7
|
|
|
8
8
|
## Simplicity
|
|
9
9
|
|