Skip to content

Commit 9c37069

Browse files
NinerianNinerian
authored
Merge pull request #27 from Staffbase/switch-linter
Switch linter
2 parents ec6f8dc + 76d8bd4 commit 9c37069

14 files changed

Lines changed: 3423 additions & 3167 deletions

‎.eslintrc‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
11
{
2-
"extends": "@staffbase/eslint-config-staffbase",
3-
"parserOptions": {
4-
"ecmaVersion": 6
5-
},
6-
"rules": {
7-
}
2+
"extends": ["plugin:node/recommended", "@staffbase/eslint-config-staffbase"],
83
}

‎.travis.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
language: node_js
22
sudo: false
33
node_js:
4-
- "6.10"
4+
- "10"
5+
- "11"
6+
- "12"
57
install:
68
- npm install
79
script:

‎docSrc/buildDoc.js‎

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -6,58 +6,58 @@ const path = require('path');
66

77
// Build Markdown file form src JSDoc
88
jsdoc2md.render({
9-
files: path.join(__dirname, '../src/**/*.js'),
10-
plugin: 'dmd-bitbucket',
9+
files: path.join(__dirname, '../src/**/*.js'),
10+
plugin: 'dmd-bitbucket',
1111
})
12-
.then( (mdData) => {
13-
// Copy JSDoc file to docs folder
14-
fs.writeFile(path.join(__dirname, '../docs/API.MD'), mdData, (err) => {
15-
if (err) {
16-
return Promise.reject(err);
17-
}
18-
return Promise.resolve('File Written');
19-
});
20-
})
21-
.then( () => {
22-
// Generate Readme.MD from Template
23-
return sections.getTplPromise();
24-
})
25-
.then( (retArr) => {
26-
const OverviewText = retArr[0];
27-
const InstallationText = retArr[1];
28-
const ApiReferenceText = retArr[2];
29-
const usageText = retArr[3];
30-
const contributionText = retArr[4];
31-
const testText = retArr[5];
32-
const licenseText = retArr[6];
12+
.then( (mdData) => {
13+
// Copy JSDoc file to docs folder
14+
fs.writeFile(path.join(__dirname, '../docs/API.MD'), mdData, (err) => {
15+
if (err) {
16+
return Promise.reject(err);
17+
}
18+
return Promise.resolve('File Written');
19+
});
20+
})
21+
.then( () => {
22+
// Generate Readme.MD from Template
23+
return sections.getTplPromise();
24+
})
25+
.then( (retArr) => {
26+
const OverviewText = retArr[0];
27+
const InstallationText = retArr[1];
28+
const ApiReferenceText = retArr[2];
29+
const usageText = retArr[3];
30+
const contributionText = retArr[4];
31+
const testText = retArr[5];
32+
const licenseText = retArr[6];
3333

34-
return new Promise( (resolve, reject) => {
35-
fs.readFile(path.join(__dirname, './mainFile.tpl'), (err, mainTpl) => {
36-
if (err) {
37-
reject(err);
38-
} else {
39-
let tpl = handlebars.compile(mainTpl.toString());
40-
let rendered = tpl({
41-
overview: OverviewText,
42-
installation: InstallationText,
43-
reference: ApiReferenceText,
44-
usage: usageText,
45-
contribution: contributionText,
46-
tests: testText,
47-
license: licenseText,
48-
});
49-
// Copy generated markdown file to root folder
50-
fs.writeFile(path.join(__dirname, '../README.MD'), rendered, (err, done) => {
51-
if (err) {
52-
reject(err);
53-
} else {
54-
resolve('done');
55-
}
56-
});
57-
}
58-
});
59-
});
60-
})
61-
.then( () => {
62-
console.log('Completed Document Generation');
63-
});
34+
return new Promise( (resolve, reject) => {
35+
fs.readFile(path.join(__dirname, './mainFile.tpl'), (err, mainTpl) => {
36+
if (err) {
37+
reject(err);
38+
} else {
39+
const tpl = handlebars.compile(mainTpl.toString());
40+
const rendered = tpl({
41+
overview: OverviewText,
42+
installation: InstallationText,
43+
reference: ApiReferenceText,
44+
usage: usageText,
45+
contribution: contributionText,
46+
tests: testText,
47+
license: licenseText,
48+
});
49+
// Copy generated markdown file to root folder
50+
fs.writeFile(path.join(__dirname, '../README.MD'), rendered, (err, done) => {
51+
if (err) {
52+
reject(err);
53+
} else {
54+
resolve('done');
55+
}
56+
});
57+
}
58+
});
59+
});
60+
})
61+
.then( () => {
62+
console.log('Completed Document Generation');
63+
});

‎docSrc/sections/index.js‎

Lines changed: 100 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -11,107 +11,107 @@ const createToolPkgName = 'create-staffbase-plugin';
1111
const SBConsts = require('../../src/utils/tokenDataConsts.js');
1212

1313
module.exports = {
14-
getTplPromise: function() {
15-
let overviewPromise = new Promise( (resolve, reject) => {
16-
fs.readFile(path.join(__dirname, 'overview.tpl'), (err, overviewData) => {
17-
if (err) {
18-
reject(err);
19-
} else {
20-
resolve(overviewData.toString());
21-
}
22-
});
23-
});
24-
let installationPromise = new Promise( (resolve, reject) => {
25-
fs.readFile(path.join(__dirname, 'installation.tpl'), (err, installationTpl) => {
26-
if (err) {
27-
reject(err);
28-
} else {
29-
let tpl = handlebars.compile(installationTpl.toString());
30-
let rendered = tpl({
31-
pluginNpmUrl: pluginNpmUrl,
32-
pluginNpmName: pluginNpmName,
33-
});
34-
resolve(rendered);
35-
}
36-
});
37-
});
38-
let apiRefPromise = new Promise( (resolve, reject) => {
39-
fs.readFile(path.join(__dirname, 'reference.tpl'), (err, apiRefTpl) => {
40-
if (err) {
41-
reject(err);
42-
} else {
43-
let tpl = handlebars.compile(apiRefTpl.toString());
44-
let rendered = tpl({
45-
apiRefPath: apiRefPath,
46-
});
47-
resolve(rendered);
48-
}
49-
});
50-
});
51-
let usagePromise = new Promise( (resolve, reject) => {
52-
fs.readFile(path.join(__dirname, 'usage.tpl'), (err, usageTpl) => {
53-
if (err) {
54-
reject(err);
55-
} else {
56-
let tpl = handlebars.compile(usageTpl.toString());
57-
let rendered = tpl({
58-
pluginNpmName: pluginNpmName,
59-
secretKeyEnv: SBConsts.secretKeyEnv,
60-
pluginIDEnv: SBConsts.pluginIDEnv,
61-
createToolPkgName: createToolPkgName,
62-
createToolURL: createToolURL,
63-
});
64-
resolve(rendered);
65-
}
66-
});
67-
});
68-
let contributionPromise = new Promise( (resolve, reject) => {
69-
fs.readFile(path.join(__dirname, 'contribution.tpl'), (err, contribTpl) => {
70-
if (err) {
71-
reject(err);
72-
} else {
73-
let tpl = handlebars.compile(contribTpl.toString());
74-
let rendered = tpl({
14+
getTplPromise: function() {
15+
const overviewPromise = new Promise( (resolve, reject) => {
16+
fs.readFile(path.join(__dirname, 'overview.tpl'), (err, overviewData) => {
17+
if (err) {
18+
reject(err);
19+
} else {
20+
resolve(overviewData.toString());
21+
}
22+
});
23+
});
24+
const installationPromise = new Promise( (resolve, reject) => {
25+
fs.readFile(path.join(__dirname, 'installation.tpl'), (err, installationTpl) => {
26+
if (err) {
27+
reject(err);
28+
} else {
29+
const tpl = handlebars.compile(installationTpl.toString());
30+
const rendered = tpl({
31+
pluginNpmUrl: pluginNpmUrl,
32+
pluginNpmName: pluginNpmName,
33+
});
34+
resolve(rendered);
35+
}
36+
});
37+
});
38+
const apiRefPromise = new Promise( (resolve, reject) => {
39+
fs.readFile(path.join(__dirname, 'reference.tpl'), (err, apiRefTpl) => {
40+
if (err) {
41+
reject(err);
42+
} else {
43+
const tpl = handlebars.compile(apiRefTpl.toString());
44+
const rendered = tpl({
45+
apiRefPath: apiRefPath,
46+
});
47+
resolve(rendered);
48+
}
49+
});
50+
});
51+
const usagePromise = new Promise( (resolve, reject) => {
52+
fs.readFile(path.join(__dirname, 'usage.tpl'), (err, usageTpl) => {
53+
if (err) {
54+
reject(err);
55+
} else {
56+
const tpl = handlebars.compile(usageTpl.toString());
57+
const rendered = tpl({
58+
pluginNpmName: pluginNpmName,
59+
secretKeyEnv: SBConsts.secretKeyEnv,
60+
pluginIDEnv: SBConsts.pluginIDEnv,
61+
createToolPkgName: createToolPkgName,
62+
createToolURL: createToolURL,
63+
});
64+
resolve(rendered);
65+
}
66+
});
67+
});
68+
const contributionPromise = new Promise( (resolve, reject) => {
69+
fs.readFile(path.join(__dirname, 'contribution.tpl'), (err, contribTpl) => {
70+
if (err) {
71+
reject(err);
72+
} else {
73+
const tpl = handlebars.compile(contribTpl.toString());
74+
const rendered = tpl({
7575

76-
});
77-
resolve(rendered);
78-
}
79-
});
80-
});
81-
let testPromise = new Promise( (resolve, reject) => {
82-
fs.readFile(path.join(__dirname, 'tests.tpl'), (err, testsTpl) => {
83-
if (err) {
84-
reject(err);
85-
} else {
86-
let tpl = handlebars.compile(testsTpl.toString());
87-
let rendered = tpl({
76+
});
77+
resolve(rendered);
78+
}
79+
});
80+
});
81+
const testPromise = new Promise( (resolve, reject) => {
82+
fs.readFile(path.join(__dirname, 'tests.tpl'), (err, testsTpl) => {
83+
if (err) {
84+
reject(err);
85+
} else {
86+
const tpl = handlebars.compile(testsTpl.toString());
87+
const rendered = tpl({
8888

89-
});
90-
resolve(rendered);
91-
}
92-
});
93-
});
94-
let licensePromise = new Promise( (resolve, reject) => {
95-
fs.readFile(path.join(__dirname, 'license.tpl'), (err, licenseTpl) => {
96-
if (err) {
97-
reject(err);
98-
} else {
99-
let tpl = handlebars.compile(licenseTpl.toString());
100-
let rendered = tpl({
89+
});
90+
resolve(rendered);
91+
}
92+
});
93+
});
94+
const licensePromise = new Promise( (resolve, reject) => {
95+
fs.readFile(path.join(__dirname, 'license.tpl'), (err, licenseTpl) => {
96+
if (err) {
97+
reject(err);
98+
} else {
99+
const tpl = handlebars.compile(licenseTpl.toString());
100+
const rendered = tpl({
101101

102-
});
103-
resolve(rendered);
104-
}
105-
});
106-
});
107-
return Promise.all([
108-
overviewPromise,
109-
installationPromise,
110-
apiRefPromise,
111-
usagePromise,
112-
contributionPromise,
113-
testPromise,
114-
licensePromise,
115-
]);
116-
},
102+
});
103+
resolve(rendered);
104+
}
105+
});
106+
});
107+
return Promise.all([
108+
overviewPromise,
109+
installationPromise,
110+
apiRefPromise,
111+
usagePromise,
112+
contributionPromise,
113+
testPromise,
114+
licensePromise,
115+
]);
116+
},
117117
};

‎package.json‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
"test": "npm run build && jest",
88
"test:verbose": "npm run build && jest --verbose",
99
"test:coverage": "npm run build && jest --coverage",
10+
"lint": "eslint --ext .js,.jsx,.ts,.tsx .",
11+
"fix": "eslint --ext .js,.jsx,.ts,.tsx --fix .",
1012
"build": "babel src --out-dir dist",
1113
"prepublish": "npm run build && npm run readme",
1214
"readme": "node docSrc/buildDoc.js"
@@ -22,25 +24,29 @@
2224
"type": "git",
2325
"url": "https://github.com/Staffbase/plugins-sdk-nodejs"
2426
},
27+
"engines": {
28+
"node": ">=10.0.0"
29+
},
2530
"author": "Hassaan Zaidi <hassaan@staffbase.com>",
2631
"license": "ISC",
2732
"devDependencies": {
28-
"@babel/cli": "^7.0.0",
29-
"@babel/core": "^7.4.3",
30-
"@babel/preset-env": "^7.0.0",
33+
"@babel/cli": "^7.8.4",
34+
"@babel/core": "^7.9.0",
35+
"@babel/preset-env": "^7.9.5",
3136
"@staffbase/eslint-config-staffbase": "^1.0.0",
3237
"babel-core": "^7.0.0-bridge.0",
33-
"babel-jest": "^24.7.1",
38+
"babel-jest": "^25.3.0",
3439
"dmd-bitbucket": "^0.1.10",
35-
"eslint": "^6.0.0",
36-
"eslint-config-google": "^0.12.0",
37-
"handlebars": "^4.1.1",
38-
"jest": "^24.7.1",
39-
"jsdoc-to-markdown": "^4.0.1",
40+
"eslint": "^6.8.0",
41+
"eslint-config-google": "^0.14.0",
42+
"eslint-plugin-node": "11.1.0",
43+
"handlebars": "^4.7.6",
44+
"jest": "^25.3.0",
45+
"jsdoc-to-markdown": "^5.0.3",
4046
"pre-commit": "^1.2.2"
4147
},
4248
"dependencies": {
4349
"jsonwebtoken": "^8.5.1",
44-
"node-rsa": "^1.0.5"
50+
"node-rsa": "^1.0.8"
4551
}
4652
}

0 commit comments

Comments
 (0)