cdk8s-plus - npm Package Compare versions

Comparing version 0.26.0 to 0.27.0-pre.3aae232c847e1fd9fe7fddebd7566ad20fdd7d36

package.json

@@ -17,25 +17,22 @@ {
     "watch": "jsii -w --silence-warnings=reserved-word",
-    "compat": "npx jsii-diff npm:$(node -p \"require('./package.json').name\")",
     "package": "jsii-pacmak",
     "build": "yarn compile",
     "eslint": "eslint . --ext .ts",
-    "docgen": "jsii-docgen",
     "test:watch": "jest --watch",
-    "test:update": "jest -u"
+    "test:update": "jest -u",
+    "compat": "npx jsii-diff npm:$(node -p \"require('./package.json').name\") -k --ignore-file .compatignore || (echo \"\nUNEXPECTED BREAKING CHANGES: add keys such as 'removed:constructs.Node.of' to .compatignore to skip.\n\" && exit 1)",
+    "docgen": "jsii-docgen"
   },
   "author": {
     "name": "Amazon Web Services",
-    "url": "https://aws.amazon.com"
+    "url": "https://aws.amazon.com",
+    "organization": true
   },
   "devDependencies": {
     "constructs": "2.0.2",
-    "cdk8s": "0.26.0",
+    "cdk8s": "0.27.0-pre.3aae232c847e1fd9fe7fddebd7566ad20fdd7d36",
     "@types/minimatch": "^3.0.3",
-    "projen": "^0.2.2",
-    "standard-version": "^8.0.0",
-    "jsii": "^1.7.0",
-    "jsii-diff": "^1.7.0",
-    "jsii-pacmak": "^1.7.0",
-    "@types/node": "^10.17.0",
-    "typescript": "^3.8.3",
+    "projen": "^0.3.3",
+    "standard-version": "^8.0.1",
+    "typescript": "^3.9.5",
     "@typescript-eslint/eslint-plugin": "^2.31.0",
@@ -48,14 +45,18 @@ "@typescript-eslint/parser": "^2.19.2",
     "json-schema": "^0.2.5",
-    "jsii-docgen": "^1.3.2",
     "jest": "^26.0.1",
     "@types/jest": "^25.2.1",
-    "ts-jest": "^26.1.0"
+    "ts-jest": "^26.1.0",
+    "@types/node": "^10.17.0",
+    "jsii": "^1.7.0",
+    "jsii-diff": "^1.7.0",
+    "jsii-pacmak": "^1.7.0",
+    "jsii-docgen": "^1.3.2"
   },
   "peerDependencies": {
     "constructs": "^2.0.2",
-    "cdk8s": "^0.26.0"
+    "cdk8s": "0.27.0-pre.3aae232c847e1fd9fe7fddebd7566ad20fdd7d36"
   },
   "dependencies": {
     "minimatch": "^3.0.4",
-    "cdk8s": "^0.26.0"
+    "cdk8s": "0.27.0-pre.3aae232c847e1fd9fe7fddebd7566ad20fdd7d36"
   },
@@ -75,4 +76,24 @@ "bundledDependencies": [
   "license": "Apache-2.0",
-  "version": "0.26.0",
+  "version": "0.27.0-pre.3aae232c847e1fd9fe7fddebd7566ad20fdd7d36",
   "types": "lib/index.d.ts",
+  "jest": {
+    "clearMocks": true,
+    "collectCoverage": true,
+    "coveragePathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "preset": "ts-jest",
+    "testMatch": [
+      "**/__tests__/**/*.ts?(x)",
+      "**/?(*.)+(spec|test).ts?(x)"
+    ],
+    "globals": {
+      "ts-jest": {
+        "tsConfig": "tsconfig.jest.json"
+      }
+    }
+  },
   "stability": "experimental",
@@ -102,23 +123,3 @@ "jsii": {
     }
-  },
-  "jest": {
-    "clearMocks": true,
-    "collectCoverage": true,
-    "coveragePathIgnorePatterns": [
-      "/node_modules/"
-    ],
-    "testPathIgnorePatterns": [
-      "/node_modules/"
-    ],
-    "preset": "ts-jest",
-    "testMatch": [
-      "**/__tests__/**/*.ts?(x)",
-      "**/?(*.)+(spec|test).ts?(x)"
-    ],
-    "globals": {
-      "ts-jest": {
-        "tsConfig": "tsconfig.jest.json"
-      }
-    }
   }
 }

README.md

@@ -140,2 +140,51 @@ # cdk8s+ (cdk8s-plus)
 
+## Installation and Usage
+
+We currently support both Python and TypeScript/JavaScript. More languages are coming soon.
+
+> We would love to hear which languages you want to see next: [Languages Support](https://github.com/awslabs/cdk8s/issues/134)
+
+### TypeScript/JavaScript
+
+`❯ npm install cdk8s-plus cdk8s`
+
+```typescript
+import * as kplus from 'cdk8s-plus';
+import * as cdk8s from 'cdk8s';
+
+const app = new cdk8s.App();
+const chart = new cdk8s.Chart(app, 'Chart');
+
+new kplus.Deployment(chart, 'Deployment', {
+  spec: {
+    replicas: 3,
+    podSpecTemplate: {
+      containers: [new kplus.Container({
+        image: 'ubuntu',
+      })],
+    },
+  },
+});
+```
+
+### Python
+
+`❯ pip install cdk8s-plus cdk8s`
+
+```python
+import cdk8s_plus as kplus
+import cdk8s
+
+app = cdk8s.App()
+chart = cdk8s.Chart(app, 'Chart')
+
+kplus.Deployment(chart, 'Deployment',
+  spec=kplus.DeploymentSpec(
+    replicas=1,
+    pod_spec_template=kplus.PodSpec(containers=[kplus.Container(image='ubuntu')])
+  )
+)
+```
+
+
 ## In Depth
@@ -142,0 +191,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1837740

increased by0.04%

Number of lines in readme file

652

increased by8.13%

Worsened metrics

Number of package files

57

decreased by-3.39%

Lines of code

17174

decreased by-0.42%

Dependency changes

• + Addedcdk8s@0.27.0-pre.3aae232c847e1fd9fe7fddebd7566ad20fdd7d36(transitive)

• - Removedcdk8s@0.26.0(transitive)

• Updatedcdk8s@0.27.0-pre.3aae232c847e1fd9fe7fddebd7566ad20fdd7d36