Skip to content

Commit 43466f1

Browse files
committed
Add to readme for formatting and linting
1 parent 2519742 commit 43466f1

File tree

1 file changed

+28
-21
lines changed

1 file changed

+28
-21
lines changed

README.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
[![Client Capabilities](https://img.shields.io/badge/Kubernetes%20client-Silver-blue.svg?style=flat&colorB=C0C0C0&colorA=306CE8)](http://bit.ly/kubernetes-client-capabilities-badge)
55
[![Client Support Level](https://img.shields.io/badge/kubernetes%20client-beta-green.svg?style=flat&colorA=306CE8)](http://bit.ly/kubernetes-client-support-badge)
66

7-
87
The Javascript clients for Kubernetes is implemented in
98
[typescript](https://typescriptlang.org), but can be called from either
109
Javascript or Typescript.
@@ -16,29 +15,30 @@ There are future plans to also build a jQuery compatible library but
1615
for now, all of the examples and instructions assume the node client.
1716

1817
# Installation
18+
1919
```console
2020
npm install @kubernetes/client-node
2121
```
2222

2323
# Example code
2424

2525
## List all pods
26+
2627
```javascript
2728
const k8s = require('@kubernetes/client-node');
2829

29-
3030
const kc = new k8s.KubeConfig();
3131
kc.loadFromDefault();
3232

3333
const k8sApi = kc.makeApiClient(k8s.Core_v1Api);
3434

35-
k8sApi.listNamespacedPod('default')
36-
.then((res) => {
37-
console.log(res.body);
38-
});
35+
k8sApi.listNamespacedPod('default').then((res) => {
36+
console.log(res.body);
37+
});
3938
```
4039

4140
## Create a new namespace
41+
4242
```javascript
4343
const k8s = require('@kubernetes/client-node');
4444

@@ -48,29 +48,28 @@ kc.loadFromDefault();
4848
const k8sApi = kc.makeApiClient(k8s.Core_v1Api);
4949

5050
var namespace = {
51-
metadata: {
52-
name: 'test'
53-
}
51+
metadata: {
52+
name: 'test',
53+
},
5454
};
5555

5656
k8sApi.createNamespace(namespace).then(
57-
(response) => {
58-
console.log('Created namespace');
59-
console.log(response);
60-
k8sApi.readNamespace(namespace.metadata.name).then(
61-
(response) => {
57+
(response) => {
58+
console.log('Created namespace');
6259
console.log(response);
63-
k8sApi.deleteNamespace(
64-
namespace.metadata.name, {} /* delete options */);
65-
});
66-
},
67-
(err) => {
68-
console.log('Error!: ' + err);
69-
}
60+
k8sApi.readNamespace(namespace.metadata.name).then((response) => {
61+
console.log(response);
62+
k8sApi.deleteNamespace(namespace.metadata.name, {} /* delete options */);
63+
});
64+
},
65+
(err) => {
66+
console.log('Error!: ' + err);
67+
},
7068
);
7169
```
7270

7371
# Additional Examples
72+
7473
There are several more examples in the [examples](https://github.com/kubernetes-client/javascript/tree/master/examples) directory.
7574

7675
# Development
@@ -92,6 +91,14 @@ cd javascript
9291
../gen/openapi/typescript.sh src settings
9392
```
9493

94+
## Formatting
95+
96+
Run `npm run format` or install an editor plugin like https://github.com/prettier/prettier-vscode.
97+
98+
## Linting
99+
100+
Run `npm run lint` or install an editor plugin like https://github.com/Microsoft/vscode-typescript-tslint-plugin
101+
95102
# Testing
96103

97104
Tests are written using the [Chai](http://chaijs.com/) library. See

0 commit comments

Comments
 (0)