dev-dict 0.4.6 → 0.4.7
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 +1 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,7 +7,6 @@
|
|
|
7
7
|
|
|
8
8
|
**dev-dict** provides an exhaustive, community-driven collection of software industry terms with clear explanations in multiple languages. Perfect for developers, technical writers, educators, and anyone building multilingual developer tools.
|
|
9
9
|
|
|
10
|
-
---
|
|
11
10
|
|
|
12
11
|
## Features
|
|
13
12
|
|
|
@@ -18,7 +17,6 @@
|
|
|
18
17
|
- **Lightweight** - Tree-shakeable ESM and UMD builds
|
|
19
18
|
- **Extensible** - Easy to contribute new terms and translations
|
|
20
19
|
|
|
21
|
-
---
|
|
22
20
|
|
|
23
21
|
## Quick Start
|
|
24
22
|
|
|
@@ -52,7 +50,6 @@ console.log(dict.react.label) // "JavaScript Library"
|
|
|
52
50
|
console.log(dict.typescript.label) // "Programming Language"
|
|
53
51
|
```
|
|
54
52
|
|
|
55
|
-
---
|
|
56
53
|
|
|
57
54
|
## API Reference
|
|
58
55
|
|
|
@@ -80,8 +77,6 @@ console.log(reactRaw.label)
|
|
|
80
77
|
- `localized?: boolean` - Return localised strings (default: `true`)
|
|
81
78
|
- `useFallback?: boolean` - Fall back to en-US for missing translations (default: `true`)
|
|
82
79
|
|
|
83
|
-
---
|
|
84
|
-
|
|
85
80
|
### `getTerms(options)`
|
|
86
81
|
|
|
87
82
|
Get all terms as an array.
|
|
@@ -102,8 +97,6 @@ console.log(termsRaw)
|
|
|
102
97
|
- `localized?: boolean` - Return localised strings (default: `true`)
|
|
103
98
|
- `useFallback?: boolean` - Fall back to en-US for missing translations (default: `true`)
|
|
104
99
|
|
|
105
|
-
---
|
|
106
|
-
|
|
107
100
|
### `getDict(options)`
|
|
108
101
|
|
|
109
102
|
Get dictionary as an object keyed by term ID.
|
|
@@ -124,8 +117,6 @@ console.log(dictRaw.react.label)
|
|
|
124
117
|
- `localized?: boolean` - Return localised strings (default: `true`)
|
|
125
118
|
- `useFallback?: boolean` - Fall back to en-US for missing translations (default: `true`)
|
|
126
119
|
|
|
127
|
-
---
|
|
128
|
-
|
|
129
120
|
### `getTypes(options)`
|
|
130
121
|
|
|
131
122
|
Get all term types (e.g., library, framework, language).
|
|
@@ -136,8 +127,6 @@ console.log(types)
|
|
|
136
127
|
// [{ id: "library", name: "Library" }, { id: "framework", name: "Framework" }, ...]
|
|
137
128
|
```
|
|
138
129
|
|
|
139
|
-
---
|
|
140
|
-
|
|
141
130
|
### `getTags(options)`
|
|
142
131
|
|
|
143
132
|
Get all term tags (e.g., frontend, backend, open_source).
|
|
@@ -148,7 +137,6 @@ console.log(tags)
|
|
|
148
137
|
// [{ id: "frontend", name: "Frontend" }, { id: "backend", name: "Backend" }, ...]
|
|
149
138
|
```
|
|
150
139
|
|
|
151
|
-
---
|
|
152
140
|
|
|
153
141
|
## Supported Languages
|
|
154
142
|
|
|
@@ -160,7 +148,6 @@ console.log(tags)
|
|
|
160
148
|
|
|
161
149
|
Want to add a new language? Check out the [Contributing Guide](./CONTRIBUTING.md#adding-a-new-language).
|
|
162
150
|
|
|
163
|
-
---
|
|
164
151
|
|
|
165
152
|
## Browse Available Terms
|
|
166
153
|
|
|
@@ -170,7 +157,6 @@ Explore the full catalogue of terms, types, and tags:
|
|
|
170
157
|
- **[Types](./docs/TYPES.md)** - Term categories (library, framework, etc.)
|
|
171
158
|
- **[Tags](./docs/TAGS.md)** - Additional classifications (frontend, backend, etc.)
|
|
172
159
|
|
|
173
|
-
---
|
|
174
160
|
|
|
175
161
|
## Contributing
|
|
176
162
|
|
|
@@ -182,7 +168,6 @@ We welcome contributions! Whether you want to:
|
|
|
182
168
|
|
|
183
169
|
Please read our [Contributing Guide](./CONTRIBUTING.md) to get started.
|
|
184
170
|
|
|
185
|
-
---
|
|
186
171
|
|
|
187
172
|
## Development
|
|
188
173
|
|
|
@@ -205,7 +190,6 @@ npx prettier --write .
|
|
|
205
190
|
|
|
206
191
|
For detailed development guidance, see [CLAUDE.md](./CLAUDE.md).
|
|
207
192
|
|
|
208
|
-
---
|
|
209
193
|
|
|
210
194
|
## Use Cases
|
|
211
195
|
|
|
@@ -215,18 +199,8 @@ For detailed development guidance, see [CLAUDE.md](./CLAUDE.md).
|
|
|
215
199
|
- **Content Management** - Maintain consistent terminology across translations
|
|
216
200
|
- **IDE Extensions** - Provide inline term explanations
|
|
217
201
|
|
|
218
|
-
---
|
|
219
202
|
|
|
220
203
|
## License
|
|
221
204
|
|
|
222
|
-
[MIT](./LICENSE)
|
|
223
|
-
|
|
224
|
-
---
|
|
225
|
-
|
|
226
|
-
## Links
|
|
227
|
-
|
|
228
|
-
- [npm Package](https://www.npmjs.com/package/dev-dict)
|
|
229
|
-
- [GitHub Repository](https://github.com/kyco/dev-dict)
|
|
230
|
-
- [Issue Tracker](https://github.com/kyco/dev-dict/issues)
|
|
231
|
-
- [Discussions](https://github.com/kyco/dev-dict/discussions)
|
|
205
|
+
[MIT](./LICENSE)
|
|
232
206
|
|
package/package.json
CHANGED