dev-dict 0.0.4

package/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing to dev-dict
+
+Thank you for contributing! This project is an open developer dictionary. Each term is a separate JSON file under `terms/`.
+
+## Adding a New Term
+
+1. Copy `template.json` to a new file in `terms/`, e.g.:
+
+```bash
+cp template.json terms/myterm.json
+```
+
+2. Fill in the fields:
+
+- id → unique identifier (e.g., REACT)
+- name → display name
+- type → library, runtime, concept, methodology, etc.
+- label → short human-readable description
+- description → one-sentence definition
+- Optional fields: tags, aka, examples, related, links, logo, color
+
+3. Save and submit a Pull Request.
+
+## Schema Versioning
+
+Each term JSON includes a schemaVersion field. Do not change it unless updating the schema intentionally.
+
+Current schema version: 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 kyco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# dev-dict
+
+The Oxford dictionary of dev terms.
+
+## Installation
+
+```bash
+npm i @_kyco/dev-dict
+```
+
+## Usage
+
+```typescript
+import devDict from '@_kyco/dev-dict`
+
+console.log(devDict.typescript.name)
+
+// OR
+
+import { dd_typescript } from '@_kyco/dev-dict`
+
+console.log(dd_typescript.name)
+```

package/index.js

@@ -0,0 +1,9 @@
+import typescript from './terms/typescript.json' assert { type: 'json' }
+
+export const dd__typescript = typescript
+
+const devDict = {
+  typescript
+}
+
+export default devDict

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "dev-dict",
+  "version": "0.0.4",
+  "description": "The Oxford dictionary of dev terms",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"This project does not have any tests which can be run yet...\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kyco/dev-dict.git"
+  },
+  "author": "Cornelius Weidmann <cornelius@kyco.io> (https://kyco.io)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kyco/dev-dict/issues"
+  },
+  "homepage": "https://github.com/kyco/dev-dict#readme"
+}

package/schema.json

@@ -0,0 +1,15 @@
+{
+  "version": "0.0.1",
+  "description": "Default schema for dev-dict terms",
+  "fields": {
+    "schemaVersion": "Specifies which schema version this file conforms to",
+    "id": "Unique identifier (e.g., typescript, react, i18n)",
+    "name": "Display name of the term",
+    "type": "Category of the term (e.g., language, library, framework, runtime, concept, methodology)",
+    "label": "Short descriptor for the term",
+    "description": "One or two sentence definition, usually from the official source",
+    "tags": "Array of related keywords",
+    "links": "Object with references (website, docs, GitHub, Wikipedia, etc.)",
+    "logo": "Object of logo URL and accent color hex"
+  }
+}

package/template.json

@@ -0,0 +1,19 @@
+{
+  "schemaVersion": "0.0.1",
+  "id": "",
+  "name": "",
+  "type": "",
+  "label": "",
+  "description": "",
+  "tags": [],
+  "links": {
+    "website": "",
+    "github": "",
+    "npm": "",
+    "wikipedia": ""
+  },
+  "logo": {
+    "url": "",
+    "hex": ""
+  }
+}

package/terms/typescript.json

@@ -0,0 +1,22 @@
+{
+  "schemaVersion": "0.0.1",
+  "id": "typescript",
+  "name": "TypeScript",
+  "type": "language",
+  "label": "High-Level Programming Language",
+  "description": "TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.",
+  "tags": [
+    "frontend",
+    "backend"
+  ],
+  "links": {
+    "website": "https://www.typescriptlang.org",
+    "github": "https://github.com/microsoft/TypeScript",
+    "npm": "https://www.npmjs.com/package/typescript",
+    "wikipedia": "https://en.wikipedia.org/wiki/TypeScript"
+  },
+  "logo": {
+    "url": "https://cdn.simpleicons.org/typescript?viewbox=auto",
+    "hex": "#3178C6"
+  }
+}