dev-dict 0.7.1 → 0.7.3

package/README.md

@@ -1,40 +1,29 @@
+<p align="center">
+  <img src="./demo/public/logo.png" alt="dev-dict" width="125">
+</p>
+
 # dev-dict
 
-> A multilingual dictionary of software development terms
 
-[![npm version](https://img.shields.io/npm/v/dev-dict.svg)](https://www.npmjs.com/package/dev-dict)
-[![npm downloads](https://img.shields.io/npm/dm/dev-dict.svg)](https://www.npmjs.com/package/dev-dict)
-[![Bundle size](https://img.shields.io/bundlephobia/minzip/dev-dict)](https://bundlephobia.com/package/dev-dict)
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./CONTRIBUTING.md)
 
-**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.
+A community-driven collection of software development terms with explanations in multiple languages. Perfect for building multilingual developer tools, documentation sites, and educational platforms.
 
-**[View Dictionary (Demo)](https://kyco.github.io/dev-dict/)**
+[![npm version](https://img.shields.io/npm/v/dev-dict.svg)](https://www.npmjs.com/package/dev-dict)
+[![Bundle size](https://img.shields.io/bundlephobia/minzip/dev-dict)](https://bundlephobia.com/package/dev-dict)
 
+**[Browse All Terms](https://kyco.github.io/dev-dict/)**
 
 ## Features
 
-- **Multilingual Support** - Terms available in English (US/GB), German, and more
-- **Type-Safe** - Built with TypeScript for excellent IDE support
-- **Flexible API** - Access localised strings or raw translation objects
-- **Comprehensive** - Covering frameworks, libraries, languages, tools, and concepts
+- **Multilingual** - English (US/GB), German, and growing
+- **Type-Safe** - Full TypeScript support
+- **Flexible** - Access localised strings or raw translation objects
 - **Lightweight** - Tree-shakeable ESM and UMD builds
-- **Extensible** - Easy to contribute new terms and translations
-
+- **Comprehensive** - Frameworks, libraries, languages, tools, and concepts
 
-## Browse Available Terms
+## Installation
 
-Explore the full catalogue of terms, types, and tags:
-
-- **[Terms](./docs/TERMS.md)** - All software development terms
-- **[Types](./docs/TYPES.md)** - Term categories (library, framework, etc.)
-- **[Tags](./docs/TAGS.md)** - Additional classifications (frontend, backend, etc.)
-
-
-## Quick Start
-
-### Installation
+### via Package Manager
 
 ```bash
 npm install dev-dict
@@ -44,168 +33,184 @@ pnpm add dev-dict
 yarn add dev-dict
 ```
 
-### Basic Usage
+### via CDN (unpkg)
 
-```typescript
-import { getTerm, getTerms, getDict } from 'dev-dict'
+```html
+<script src="https://unpkg.com/dev-dict@latest/dist/dev-dict.min.js"></script>
+<script>
+  // Access the library via the global 'devdict' object
+  const { terms: dict, types, tags, locales, utils } = devdict
 
-// Get a single term
-const react = getTerm({ id: 'react', locale: 'en-US' })
-console.log(react.label)      // "JavaScript Library"
-console.log(react.definition) // "A JavaScript library for building user interfaces..."
+  // Get all terms for a locale
+  const allTerms = utils.getTerms({ dict, locale: 'en-US' })
 
-// Get all terms as an array
-const terms = getTerms({ locale: 'en-US' })
-console.log(terms) // [{ id: "react", name: "React", ... }, ...]
-
-// Get dictionary object (keyed by ID)
-const dict = getDict({ locale: 'en-US' })
-console.log(dict.react.label) // "JavaScript Library"
-console.log(dict.typescript.label) // "Programming Language"
+  console.log(allTerms)
+</script>
 ```
 
+## Quick Start
 
-## API Reference
+### Option 1: Use All Terms
+
+Import the complete dictionary to access all available terms.
+
+```typescript
+import { terms as dict } from 'dev-dict'
+import { getTerms, getTags, getTypes } from 'dev-dict/utils'
+
+// Get all terms for a locale
+const allTerms = getTerms({ dict, locale: 'en-US' })
+
+// Get types and tags
+const types = getTypes({ dict, locale: 'en-US' })
+const tags = getTags({ dict, locale: 'en-US' })
+
+// Display a term
+allTerms.forEach(term => {
+  console.log(term.name)       // "React"
+  console.log(term.label)      // "JavaScript Library"
+  console.log(term.definition) // "A JavaScript library for..."
+  console.log(term.type)       // [{ id: "library", name: "Library" }]
+  console.log(term.tags)       // [{ id: "frontend", name: "Frontend" }, ...]
+})
+```
 
-### `getTerm(options)`
+### Option 2: Use Custom Terms
 
-Get a single term by ID.
+Import only the specific terms you need for better tree-shaking and smaller bundle size.
 
 ```typescript
-// Localised (default)
-const reactEn = getTerm({ id: 'react', locale: 'en-US' })
-console.log(reactEn.label) // "JavaScript Library"
+import { react, typescript, node_js } from 'dev-dict/terms'
 
-const reactDe = getTerm({ id: 'react', locale: 'de-DE' })
-console.log(reactDe.label) // "JavaScript-Bibliothek"
+// Create a custom dictionary with only the terms you need
+const dict = { react, typescript, node_js }
 
-// Raw (all translations)
-const reactRaw = getTerm({ id: 'react', localized: false })
-console.log(reactRaw.label)
-// { "en-US": "JavaScript Library", "de-DE": "JavaScript-Bibliothek", ... }
+// Then use the same helper functions as Option 1
 ```
 
-**Options:**
-- `id: string` - Term identifier (required)
-- `locale?: string` - Target locale (default: `'en-US'`)
-- `localized?: boolean` - Return localised strings (default: `true`)
-- `useFallback?: boolean` - Fall back to en-US for missing translations (default: `true`)
+## API Reference
 
-### `getTerms(options)`
-
-Get all terms as an array.
+### Import Data
 
 ```typescript
-// Localised
-const terms = getTerms({ locale: 'en-US' })
-console.log(terms) // [{ id: "react", label: "JavaScript Library" }, ...]
-
-// Raw
-const termsRaw = getTerms({ localized: false })
-console.log(termsRaw)
-// [{ id: "react", label: { "en-US": "...", "de-DE": "..." } }, ...]
+import { terms, types, tags, locales } from 'dev-dict'
 ```
 
-**Options:**
-- `locale?: string` - Target locale (default: `'en-US'`)
-- `localized?: boolean` - Return localised strings (default: `true`)
-- `useFallback?: boolean` - Fall back to en-US for missing translations (default: `true`)
+- `terms` - Raw terms dictionary
+- `types` - Type constants and definitions
+- `tags` - Tag constants and definitions
+- `locales` - Locale constants
+
+### Helper Functions
+
+Import from `dev-dict/utils`:
 
-### `getDict(options)`
+```typescript
+import { getTerms, getTypes, getTags } from 'dev-dict/utils'
+```
+
+#### `getTerms(options)`
 
-Get dictionary as an object keyed by term ID.
+Get all terms as an array.
 
 ```typescript
-// Localised
-const dict = getDict({ locale: 'en-US' })
-console.log(dict.react.label) // "JavaScript Library"
-
-// Raw
-const dictRaw = getDict({ localized: false })
-console.log(dictRaw.react.label)
-// { "en-US": "JavaScript Library", "de-DE": "JavaScript-Bibliothek", ... }
+const terms = getTerms({
+  dict,
+  locale: 'en-US',
+  useFallback: true
+})
 ```
 
 **Options:**
+- `dict: TDevDict` - The terms dictionary (required)
 - `locale?: string` - Target locale (default: `'en-US'`)
-- `localized?: boolean` - Return localised strings (default: `true`)
 - `useFallback?: boolean` - Fall back to en-US for missing translations (default: `true`)
 
-### `getTypes(options)`
+**Returns:** `TTermLocalized[]` - Array of localised terms
+
+#### `getTypes(options)`
 
-Get all term types (e.g., library, framework, language).
+Get all term types.
 
 ```typescript
-const types = getTypes({ locale: 'en-US' })
-console.log(types)
+const types = getTypes({
+  dict,
+  locale: 'en-US'
+})
 // [{ id: "library", name: "Library" }, { id: "framework", name: "Framework" }, ...]
 ```
 
-### `getTags(options)`
+#### `getTags(options)`
 
-Get all term tags (e.g., frontend, backend, open_source).
+Get all term tags.
 
 ```typescript
-const tags = getTags({ locale: 'en-US' })
-console.log(tags)
+const tags = getTags({
+  dict,
+  locale: 'en-US'
+})
 // [{ id: "frontend", name: "Frontend" }, { id: "backend", name: "Backend" }, ...]
 ```
 
+### Term Structure
+
+```typescript
+{
+  id: string              // Unique identifier
+  name: string            // Display name
+  altName?: string        // Optional abbreviation/short name
+  label: string           // Descriptive type (e.g., "UI Library")
+  definition: string      // Full explanation
+  type: Array<{           // Categories
+    id: string
+    name: string
+  }>
+  tags: Array<{           // Additional classifications
+    id: string
+    name: string
+  }>
+  links?: {               // Optional external links
+    website: string
+    github?: string
+    npm?: string
+    wikipedia?: string
+  }
+}
+```
 
 ## Supported Languages
 
 | Locale | Language | Status |
 |--------|----------|--------|
-| `en-US` | English (United States) | ✅ Primary (all terms) |
+| `en-US` | English (United States) | ✅ Primary |
 | `en-GB` | English (Great Britain) | ✅ Supported |
 | `de-DE` | German (Germany) | ✅ Supported |
 
-Want to add a new language? Check out the [Contributing Guide](./CONTRIBUTING.md#adding-a-new-language).
+Want to add a language? See [CONTRIBUTING.md](./CONTRIBUTING.md#adding-a-new-language)
 
+## Browse Terms
 
-## Contributing
+- **[Terms](./docs/TERMS.md)** - All software development terms
+- **[Types](./docs/TYPES.md)** - Term categories
+- **[Tags](./docs/TAGS.md)** - Additional classifications
 
-We welcome contributions! Whether you want to:
-- Add a new term
-- Provide translations
-- Fix errors or typos
-- Suggest improvements
+## Contributing
 
-Please read our [Contributing Guide](./CONTRIBUTING.md) to get started.
+Contributions welcome! Add terms, provide translations, fix errors, or suggest improvements.
 
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
 
 ## Development
 
 ```bash
-# Install dependencies
-pnpm install
-
-# Build library
-pnpm build
-
-# Run demo site locally
-pnpm demo:dev
-
-# Build demo site
-pnpm demo:build
-
-# Preview demo build
-pnpm demo:preview
-
-# Lint code
-npx eslint .
-
-# Format code
-npx prettier --write .
+pnpm install      # Install dependencies
+pnpm build        # Build library
+pnpm demo:dev     # Run demo site (http://localhost:5173)
+pnpm demo:build   # Build demo site
 ```
 
-For detailed development guidance, see [CLAUDE.md](./CLAUDE.md).
-
+See [CLAUDE.md](./.claude/CLAUDE.md) for detailed development guidance.
 
-## Use Cases
+## License
 
-- **Documentation Sites** - Display term definitions with automatic localisation
-- **Educational Platforms** - Teach developers in their native language
-- **Developer Tools** - Add contextual help for technical terms
-- **Content Management** - Maintain consistent terminology across translations
-- **IDE Extensions** - Provide inline term explanations
+MIT

package/dist/common/index.d.ts

@@ -0,0 +1,6 @@
+export declare const MISC: {};
+export declare const CONFIG: {
+    readonly DEFAULT_LOCALE: "en-US";
+    readonly USE_FALLBACK: true;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,IAAI,IAAc,CAAA;AAE/B,eAAO,MAAM,MAAM;;;CAGT,CAAA"}

package/dist/data/index.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=index.d.ts.map

package/dist/data/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data/index.ts"],"names":[],"mappings":""}

package/dist/data/locales/index.d.ts

@@ -0,0 +1,6 @@
+export declare const LOCALES: {
+    readonly EN_US: "en-US";
+    readonly EN_GB: "en-GB";
+    readonly DE_DE: "de-DE";
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/data/locales/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/data/locales/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO;;;;CAIV,CAAA"}

package/dist/data/sources/ai_generated.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    readonly id: "ai_generated";
+    readonly name: {
+        readonly "en-US": "AI Generated";
+        readonly "en-GB": "en-US";
+        readonly "de-DE": "KI-generiert";
+    };
+};
+export default _default;
+//# sourceMappingURL=ai_generated.d.ts.map

package/dist/data/sources/ai_generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai_generated.d.ts","sourceRoot":"","sources":["../../../src/data/sources/ai_generated.ts"],"names":[],"mappings":";;;;;;;;AAMA,wBAQgC"}

package/dist/data/sources/community.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    readonly id: "community";
+    readonly name: {
+        readonly "en-US": "Community Consensus";
+        readonly "en-GB": "en-US";
+        readonly "de-DE": "Gemeinschaftskonsens";
+    };
+};
+export default _default;
+//# sourceMappingURL=community.d.ts.map

package/dist/data/sources/community.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"community.d.ts","sourceRoot":"","sources":["../../../src/data/sources/community.ts"],"names":[],"mappings":";;;;;;;;AAMA,wBAQgC"}

package/dist/data/sources/index.d.ts

@@ -0,0 +1,69 @@
+export declare const RAW_SOURCES: {
+    readonly ai_generated: {
+        readonly id: "ai_generated";
+        readonly name: {
+            readonly "en-US": "AI Generated";
+            readonly "en-GB": "en-US";
+            readonly "de-DE": "KI-generiert";
+        };
+    };
+    readonly community: {
+        readonly id: "community";
+        readonly name: {
+            readonly "en-US": "Community Consensus";
+            readonly "en-GB": "en-US";
+            readonly "de-DE": "Gemeinschaftskonsens";
+        };
+    };
+    readonly official_website: {
+        readonly id: "official_website";
+        readonly name: {
+            readonly "en-US": "Official Website";
+            readonly "en-GB": "en-US";
+            readonly "de-DE": "Offizielle Website";
+        };
+    };
+    readonly wikipedia: {
+        readonly id: "wikipedia";
+        readonly name: {
+            readonly "en-US": "Wikipedia";
+            readonly "en-GB": "en-US";
+            readonly "de-DE": "Wikipedia";
+        };
+    };
+};
+export declare const SOURCES: {
+    readonly ai_generated: {
+        readonly id: "ai_generated";
+        readonly name: {
+            readonly "en-US": "AI Generated";
+            readonly "en-GB": "en-US";
+            readonly "de-DE": "KI-generiert";
+        };
+    };
+    readonly community: {
+        readonly id: "community";
+        readonly name: {
+            readonly "en-US": "Community Consensus";
+            readonly "en-GB": "en-US";
+            readonly "de-DE": "Gemeinschaftskonsens";
+        };
+    };
+    readonly official_website: {
+        readonly id: "official_website";
+        readonly name: {
+            readonly "en-US": "Official Website";
+            readonly "en-GB": "en-US";
+            readonly "de-DE": "Offizielle Website";
+        };
+    };
+    readonly wikipedia: {
+        readonly id: "wikipedia";
+        readonly name: {
+            readonly "en-US": "Wikipedia";
+            readonly "en-GB": "en-US";
+            readonly "de-DE": "Wikipedia";
+        };
+    };
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/data/sources/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/data/sources/index.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAKd,CAAA;AAEV,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA8E,CAAA"}

package/dist/data/sources/official_website.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    readonly id: "official_website";
+    readonly name: {
+        readonly "en-US": "Official Website";
+        readonly "en-GB": "en-US";
+        readonly "de-DE": "Offizielle Website";
+    };
+};
+export default _default;
+//# sourceMappingURL=official_website.d.ts.map

package/dist/data/sources/official_website.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"official_website.d.ts","sourceRoot":"","sources":["../../../src/data/sources/official_website.ts"],"names":[],"mappings":";;;;;;;;AAMA,wBAQgC"}

package/dist/data/sources/wikipedia.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    readonly id: "wikipedia";
+    readonly name: {
+        readonly "en-US": "Wikipedia";
+        readonly "en-GB": "en-US";
+        readonly "de-DE": "Wikipedia";
+    };
+};
+export default _default;
+//# sourceMappingURL=wikipedia.d.ts.map

package/dist/data/sources/wikipedia.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wikipedia.d.ts","sourceRoot":"","sources":["../../../src/data/sources/wikipedia.ts"],"names":[],"mappings":";;;;;;;;AAMA,wBAQgC"}

package/dist/data/tags/automation.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    readonly id: "automation";
+    readonly name: {
+        readonly "en-US": "Automation";
+        readonly "en-GB": "en-US";
+        readonly "de-DE": "Automatisierung";
+    };
+};
+export default _default;
+//# sourceMappingURL=automation.d.ts.map

package/dist/data/tags/automation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"automation.d.ts","sourceRoot":"","sources":["../../../src/data/tags/automation.ts"],"names":[],"mappings":";;;;;;;;AAMA,wBAQ6B"}

package/dist/data/tags/backend.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    readonly id: "backend";
+    readonly name: {
+        readonly "en-US": "Backend";
+        readonly "en-GB": "en-US";
+        readonly "de-DE": "Backend";
+    };
+};
+export default _default;
+//# sourceMappingURL=backend.d.ts.map

package/dist/data/tags/backend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["../../../src/data/tags/backend.ts"],"names":[],"mappings":";;;;;;;;AAMA,wBAQ6B"}

package/dist/data/tags/cryptography.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    readonly id: "cryptography";
+    readonly name: {
+        readonly "en-US": "Cryptography";
+        readonly "en-GB": "en-US";
+        readonly "de-DE": "Kryptografie";
+    };
+};
+export default _default;
+//# sourceMappingURL=cryptography.d.ts.map

package/dist/data/tags/cryptography.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cryptography.d.ts","sourceRoot":"","sources":["../../../src/data/tags/cryptography.ts"],"names":[],"mappings":";;;;;;;;AAMA,wBAQ6B"}

package/dist/data/tags/e2e.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    readonly id: "e2e";
+    readonly name: {
+        readonly "en-US": "E2E";
+        readonly "en-GB": "en-US";
+        readonly "de-DE": "en-US";
+    };
+};
+export default _default;
+//# sourceMappingURL=e2e.d.ts.map

package/dist/data/tags/e2e.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"e2e.d.ts","sourceRoot":"","sources":["../../../src/data/tags/e2e.ts"],"names":[],"mappings":";;;;;;;;AAMA,wBAQ6B"}

package/dist/data/tags/frontend.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    readonly id: "frontend";
+    readonly name: {
+        readonly "en-US": "Frontend";
+        readonly "en-GB": "en-US";
+        readonly "de-DE": "Frontend";
+    };
+};
+export default _default;
+//# sourceMappingURL=frontend.d.ts.map

package/dist/data/tags/frontend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontend.d.ts","sourceRoot":"","sources":["../../../src/data/tags/frontend.ts"],"names":[],"mappings":";;;;;;;;AAMA,wBAQ6B"}