create-contextkit 0.1.1 → 0.2.0

package/dist/index.js

@@ -55,11 +55,6 @@ function main() {
   fs.mkdirSync(projectDir, { recursive: true });
   const createdFiles = [];
   copyDir(templatesDir, projectDir, createdFiles, projectDir, projectName, displayName);
-  const emptyDirs = ["context/entities", "context/terms"];
-  for (const dir of emptyDirs) {
-    const dirPath = path.join(projectDir, dir);
-    fs.mkdirSync(dirPath, { recursive: true });
-  }
   for (const file of createdFiles) {
     console.log(`  Created ${file}`);
   }
@@ -68,5 +63,6 @@ function main() {
   console.log(`  cd ${projectName}`);
   console.log("  pnpm add -D @runcontext/cli");
   console.log("  npx context lint");
+  console.log("  npx context tier");
 }
 main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-contextkit",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Scaffold a new ContextKit project",
   "license": "MIT",
   "author": "Eric Kittelson",
@@ -19,6 +19,7 @@
     "clean": "rm -rf dist"
   },
   "devDependencies": {
+    "@types/node": "^25.3.3",
     "tsup": "^8.4.0",
     "typescript": "^5.7.0"
   }

package/templates/minimal/context/glossary/example-term.term.yaml

@@ -0,0 +1,5 @@
+id: revenue
+definition: "Total value of completed orders before refunds"
+synonyms: [sales, order revenue]
+owner: example-team
+tags: [finance]

package/templates/minimal/context/governance/example-model.governance.yaml

@@ -0,0 +1,23 @@
+model: example-model
+owner: example-team
+trust: endorsed
+security: internal
+tags: [orders, revenue]
+
+datasets:
+  orders:
+    grain: "One row per order"
+    refresh: daily
+    table_type: fact
+
+fields:
+  orders.amount:
+    semantic_role: metric
+    default_aggregation: SUM
+    additive: true
+  orders.order_id:
+    semantic_role: identifier
+  orders.customer_id:
+    semantic_role: identifier
+  orders.order_date:
+    semantic_role: date

package/templates/minimal/context/lineage/example-model.lineage.yaml

@@ -0,0 +1,12 @@
+model: example-model
+
+upstream:
+  - source: source-system.raw-data
+    type: pipeline
+    refresh: daily
+    notes: Raw data ingested daily via ETL pipeline
+
+downstream:
+  - target: analytics-dashboard
+    type: dashboard
+    notes: Executive KPI dashboard

package/templates/minimal/context/models/example-model.osi.yaml

@@ -0,0 +1,51 @@
+version: "1.0"
+
+semantic_model:
+  - name: example-model
+    description: Example orders analytics model
+    ai_context:
+      instructions: "Use for order and revenue analysis"
+      synonyms: ["orders model"]
+
+    datasets:
+      - name: orders
+        source: warehouse.public.orders
+        primary_key: [order_id]
+        description: "Orders fact table"
+        fields:
+          - name: order_id
+            expression:
+              dialects:
+                - dialect: ANSI_SQL
+                  expression: order_id
+            description: Unique order identifier
+          - name: customer_id
+            expression:
+              dialects:
+                - dialect: ANSI_SQL
+                  expression: customer_id
+            description: Foreign key to customers
+            dimension:
+              is_time: false
+          - name: amount
+            expression:
+              dialects:
+                - dialect: ANSI_SQL
+                  expression: amount
+            description: Order amount in USD
+          - name: order_date
+            expression:
+              dialects:
+                - dialect: ANSI_SQL
+                  expression: order_date
+            description: Date the order was placed
+            dimension:
+              is_time: true
+
+    metrics:
+      - name: total_revenue
+        expression:
+          dialects:
+            - dialect: ANSI_SQL
+              expression: "SUM(orders.amount)"
+        description: Total revenue across all orders

package/templates/minimal/context/owners/example-team.owner.yaml

@@ -1,3 +1,4 @@
 id: example-team
 display_name: Example Team
 email: team@example.com
+description: "Responsible for data and analytics"

package/templates/minimal/context/rules/example-model.rules.yaml

@@ -0,0 +1,19 @@
+model: example-model
+
+golden_queries:
+  - question: "What is total revenue?"
+    sql: |
+      SELECT SUM(amount) AS total_revenue
+      FROM orders
+    dialect: ANSI_SQL
+    tags: [revenue]
+
+business_rules:
+  - name: positive-amounts
+    definition: "Only include orders with positive amounts in revenue calculations"
+    enforcement:
+      - "Filter to amount > 0 when calculating revenue"
+    avoid:
+      - "Do not include negative or zero amounts in revenue totals"
+    tables: [orders]
+    applied_always: true

package/templates/minimal/contextkit.config.yaml.template

@@ -1,4 +1,3 @@
-project:
-  id: {{PROJECT_NAME}}
-  displayName: "{{PROJECT_DISPLAY_NAME}}"
-  version: "0.1.0"
+context_dir: context
+output_dir: dist
+minimum_tier: bronze

package/templates/minimal/context/concepts/example-concept.ctx.yaml

@@ -1,5 +0,0 @@
-id: example-concept
-definition: An example concept to get you started.
-owner: example-team
-status: draft
-tags: [example]

package/templates/minimal/context/policies/example-policy.policy.yaml

@@ -1,8 +0,0 @@
-id: example-policy
-description: An example policy.
-rules:
-  - priority: 100
-    when:
-      tags_any: [sensitive]
-    then:
-      require_role: admin

package/templates/minimal/context/products/example-product.ctx.yaml

@@ -1,4 +0,0 @@
-id: example-product
-description: An example product to get you started.
-owner: example-team
-tags: [example]