Merge pull request kubernetes-client#185 from drubin/improvements

Various small improvements

Author: k8s-ci-robot

.travis.yml

@@ -8,3 +8,4 @@ install:
 script:
   - 'npm test'
   - 'npm run lint'
+  - 'npm run lint-examples'

README.md

@@ -16,8 +16,8 @@ There are future plans to also build a jQuery compatible library but
 for now, all of the examples and instructions assume the node client.
 
 # Installation
-```sh
-$ npm install @kubernetes/client-node
+```console
+npm install @kubernetes/client-node
 ```
 
 # Example code
@@ -85,7 +85,7 @@ npm install
 
 ## (re) Generating code
 
-```
+```console
 cd ../
 git clone https://github.com/kubernetes-client/gen
 cd javascript
@@ -95,7 +95,7 @@ cd javascript
 # Testing
 
 Tests are written using the [Chai](http://chaijs.com/) library. See
-[`config_test.ts`](./config_test.ts) for an example.
+[`config_test.ts`](./src/config_test.ts) for an example.
 
 To run tests, execute the following:
 

examples/typescript/attach/attach-example.ts

@@ -1,7 +1,8 @@
 import k8s = require('@kubernetes/client-node');
 
-let kc = new k8s.KubeConfig();
+const kc = new k8s.KubeConfig();
 kc.loadFromDefault();
 
-let attach = new k8s.Attach(kc);
-attach.attach('default', 'nginx-4217019353-9gl4s', 'nginx', process.stdout, process.stderr, null /* stdin */, false /* tty */);
+const attach = new k8s.Attach(kc);
+attach.attach('default', 'nginx-4217019353-9gl4s', 'nginx',
+    process.stdout, process.stderr, null /* stdin */, false /* tty */);

examples/typescript/exec/exec-example.ts

@@ -1,9 +1,10 @@
 import k8s = require('@kubernetes/client-node');
 
-let command = process.argv[2];
+const command = process.argv[2];
 
-let kc = new k8s.KubeConfig();
+const kc = new k8s.KubeConfig();
 kc.loadFromDefault();
 
-let exec = new k8s.Exec(kc);
-exec.exec('default', 'nginx-4217019353-9gl4s', 'nginx', command, process.stdout, process.stderr, process.stdin, true /* tty */);
+const exec = new k8s.Exec(kc);
+exec.exec('default', 'nginx-4217019353-9gl4s', 'nginx', command,
+    process.stdout, process.stderr, process.stdin, true /* tty */);

examples/typescript/port-forward/port-forward.ts

@@ -11,9 +11,8 @@ const forward = new k8s.PortForward(kc);
 // This simple server just forwards traffic from itself to a service running in kubernetes
 // -> localhost:8080 -> port-forward-tunnel -> kubernetes-pod
 // This is basically equivalent to 'kubectl port-forward ...' but in TypeScript.
-const server = net.createServer(function(socket) {
+const server = net.createServer((socket) => {
     forward.portForward('default', 'demo', [8080], socket, null, socket);
 });
 
 server.listen(8080, '127.0.0.1');
-

examples/typescript/simple/example.ts

@@ -6,9 +6,10 @@ const k8sApi = kc.makeApiClient(k8s.Core_v1Api);
 
 k8sApi.listNamespacedPod('default')
     .then((res) => {
+        // tslint:disable-next-line:no-console
         console.log(res.body);
     });
 
 // Example of instantiating a Pod object.
-let pod = {
+const pod = {
 } as k8s.V1Pod;

examples/typescript/tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "../../tsconfig.json",
+    "include": [
+      "**/*.ts"
+    ]
+  }
+  

examples/typescript/watch/watch-example.ts

@@ -10,19 +10,24 @@ const req = watch.watch('/api/v1/namespaces',
     // callback is called for each received object.
     (type, obj) => {
         if (type === 'ADDED') {
+            // tslint:disable-next-line:no-console
             console.log('new object:');
         } else if (type === 'MODIFIED') {
+            // tslint:disable-next-line:no-console
             console.log('changed object:');
         } else if (type === 'DELETED') {
+            // tslint:disable-next-line:no-console
             console.log('deleted object:');
         } else {
+            // tslint:disable-next-line:no-console
             console.log('unknown type: ' + type);
         }
-
+        // tslint:disable-next-line:no-console
         console.log(obj);
     },
     // done callback is called if the watch terminates normally
     (err) => {
+        // tslint:disable-next-line:no-console
         console.log(err);
     });
 

package.json

@@ -15,6 +15,7 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "lint": "tslint --project \".\"",
+    "lint-examples": "tslint --project \"./examples/typescript\"",
     "clean": "rm -Rf node_modules/ dist/",
     "build": "tsc",
     "watch": "tsc --watch",

src/package_test.ts

@@ -0,0 +1,10 @@
+import { expect } from 'chai';
+
+// Generic set of tests to verify the package is built and configured correctly
+describe('package', () => {
+    it('package-lock.json should match package.json', () => {
+        const v1 = require('../package.json').version;
+        const v2 = require('../package-lock.json').version;
+        expect(v1).to.equal(v2);
+    });
+});