dev-dict 0.12.2 → 0.12.3
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/README.md +18 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
# dev-dict
|
|
6
6
|
|
|
7
|
-
A
|
|
7
|
+
A collection of software development terms (with multilingual support). Useful for building developer tools, documentation sites, personal portfolios, etc.
|
|
8
8
|
|
|
9
|
-
**[Docs](https://kyco.github.io/dev-dict/docs)** · **[Browse
|
|
9
|
+
**[Docs](https://kyco.github.io/dev-dict/docs)** · **[Browse all terms](https://kyco.github.io/dev-dict/)**
|
|
10
10
|
|
|
11
11
|
## Installation
|
|
12
12
|
|
|
@@ -14,57 +14,47 @@ A community-driven collection of software development terms with explanations in
|
|
|
14
14
|
npm install dev-dict
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## Usage
|
|
18
18
|
|
|
19
19
|
```typescript
|
|
20
20
|
import { terms } from 'dev-dict'
|
|
21
21
|
import { getTerms } from 'dev-dict/utils'
|
|
22
22
|
|
|
23
|
-
//
|
|
24
|
-
const dictionary = getTerms({ terms
|
|
23
|
+
// Define dictionary
|
|
24
|
+
const dictionary = getTerms({ terms })
|
|
25
25
|
|
|
26
26
|
// Display terms
|
|
27
27
|
dictionary.forEach(term => {
|
|
28
|
-
console.log(term.name) // "React"
|
|
29
|
-
console.log(term.label) // "JavaScript Library"
|
|
28
|
+
console.log(term.name) // "React", "TypeScript", etc.
|
|
30
29
|
})
|
|
31
30
|
```
|
|
32
31
|
|
|
33
|
-
For detailed API documentation, code examples, and more, visit the **[documentation](https://kyco.github.io/dev-dict/docs)**.
|
|
34
32
|
|
|
35
|
-
## Bundle
|
|
33
|
+
## Bundle size
|
|
36
34
|
|
|
37
|
-
Dev-dict contains 220+ terms. To keep your bundle small
|
|
38
|
-
|
|
39
|
-
**Preferred — import specific terms from `dev-dict/terms`:**
|
|
35
|
+
Dev-dict contains 220+ terms. To keep your bundle small import only the terms you need.
|
|
40
36
|
|
|
41
37
|
```typescript
|
|
42
|
-
// GOOD
|
|
38
|
+
// GOOD
|
|
43
39
|
import { react, typescript } from 'dev-dict/terms'
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
**Avoid importing from the root entry point** when you only need a subset of terms — it pulls in the entire dictionary at once and cannot be tree-shaken:
|
|
47
40
|
|
|
48
|
-
|
|
49
|
-
// BAD - Includes all 220+ terms regardless of what you use
|
|
41
|
+
// BAD
|
|
50
42
|
import { terms } from 'dev-dict'
|
|
51
43
|
```
|
|
52
44
|
|
|
53
45
|
The root entry is best suited for server-side or build-time use cases where you need the full dataset (e.g. generating a static glossary page).
|
|
54
46
|
|
|
55
|
-
## Supported
|
|
56
|
-
|
|
57
|
-
| Locale | Language | Status |
|
|
58
|
-
|--------|----------|--------|
|
|
59
|
-
| `en-US` | English (United States) | ✅ Primary |
|
|
60
|
-
| `en-GB` | English (Great Britain) | ✅ Supported |
|
|
61
|
-
| `de-DE` | German (Germany) | ✅ Supported |
|
|
47
|
+
## Supported languages
|
|
62
48
|
|
|
63
|
-
|
|
49
|
+
| Locale | Language |
|
|
50
|
+
|---------|-------------------------------------|
|
|
51
|
+
| `en-US` | English (United States) - _Default_ |
|
|
52
|
+
| `en-GB` | English (Great Britain) |
|
|
53
|
+
| `de-DE` | German (Germany) |
|
|
64
54
|
|
|
65
55
|
## Contributing
|
|
66
56
|
|
|
67
|
-
Contributions welcome!
|
|
57
|
+
Contributions welcome! Please help add terms, provide translations, fix errors and/or suggest improvements.
|
|
68
58
|
|
|
69
59
|
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
|
|
70
60
|
|
|
@@ -74,8 +64,6 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
|
|
|
74
64
|
pnpm install # Install dependencies
|
|
75
65
|
pnpm build # Build library
|
|
76
66
|
pnpm test # Run tests
|
|
77
|
-
pnpm demo:dev # Run demo site (http://localhost:5173)
|
|
67
|
+
pnpm demo:dev # Run demo site (http://localhost:5173/dev-dict)
|
|
78
68
|
pnpm demo:build # Build demo site
|
|
79
69
|
```
|
|
80
|
-
|
|
81
|
-
See [CLAUDE.md](./.claude/CLAUDE.md) for detailed development guidance.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dev-dict",
|
|
3
|
-
"version": "0.12.
|
|
3
|
+
"version": "0.12.3",
|
|
4
4
|
"description": "A community-driven collection of software development terms with explanations in multiple languages. Perfect for building multilingual developer tools, documentation sites, and educational platforms.",
|
|
5
5
|
"author": "Cornelius Weidmann <cornelius@kyco.io> (https://kyco.io)",
|
|
6
6
|
"license": "MIT",
|