mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-20 07:35:05 -04:00
lint: Run eslint --fix on bin/ and tests/
This commit is contained in:
Richard Hansen
John McLear
parent
0625739cb8
commit
b8d07a42eb
78 changed files with 4319 additions and 4599 deletions
|
|
@ -9,96 +9,96 @@ node bin/plugins/checkPlugins.js ep_whatever autofix autocommit
|
|||
|
||||
*/
|
||||
|
||||
const fs = require("fs");
|
||||
const { exec } = require("child_process");
|
||||
const fs = require('fs');
|
||||
const {exec} = require('child_process');
|
||||
|
||||
// get plugin name & path from user input
|
||||
const pluginName = process.argv[2];
|
||||
|
||||
if(!pluginName){
|
||||
console.error("no plugin name specified");
|
||||
if (!pluginName) {
|
||||
console.error('no plugin name specified');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const pluginPath = "node_modules/"+pluginName;
|
||||
const pluginPath = `node_modules/${pluginName}`;
|
||||
|
||||
console.log("Checking the plugin: "+ pluginName)
|
||||
console.log(`Checking the plugin: ${pluginName}`);
|
||||
|
||||
// Should we autofix?
|
||||
if (process.argv[3] && process.argv[3] === "autofix") var autoFix = true;
|
||||
if (process.argv[3] && process.argv[3] === 'autofix') var autoFix = true;
|
||||
|
||||
// Should we update files where possible?
|
||||
if (process.argv[5] && process.argv[5] === "autoupdate") var autoUpdate = true;
|
||||
if (process.argv[5] && process.argv[5] === 'autoupdate') var autoUpdate = true;
|
||||
|
||||
// Should we automcommit and npm publish?!
|
||||
if (process.argv[4] && process.argv[4] === "autocommit") var autoCommit = true;
|
||||
if (process.argv[4] && process.argv[4] === 'autocommit') var autoCommit = true;
|
||||
|
||||
|
||||
if(autoCommit){
|
||||
console.warn("Auto commit is enabled, I hope you know what you are doing...")
|
||||
if (autoCommit) {
|
||||
console.warn('Auto commit is enabled, I hope you know what you are doing...');
|
||||
}
|
||||
|
||||
fs.readdir(pluginPath, function (err, rootFiles) {
|
||||
//handling error
|
||||
fs.readdir(pluginPath, (err, rootFiles) => {
|
||||
// handling error
|
||||
if (err) {
|
||||
return console.log('Unable to scan directory: ' + err);
|
||||
return console.log(`Unable to scan directory: ${err}`);
|
||||
}
|
||||
|
||||
// rewriting files to lower case
|
||||
var files = [];
|
||||
const files = [];
|
||||
|
||||
// some files we need to know the actual file name. Not compulsory but might help in the future.
|
||||
var readMeFileName;
|
||||
var repository;
|
||||
var hasAutoFixed = false;
|
||||
let readMeFileName;
|
||||
let repository;
|
||||
let hasAutoFixed = false;
|
||||
|
||||
for (var i = 0; i < rootFiles.length; i++) {
|
||||
if(rootFiles[i].toLowerCase().indexOf("readme") !== -1) readMeFileName = rootFiles[i];
|
||||
for (let i = 0; i < rootFiles.length; i++) {
|
||||
if (rootFiles[i].toLowerCase().indexOf('readme') !== -1) readMeFileName = rootFiles[i];
|
||||
files.push(rootFiles[i].toLowerCase());
|
||||
}
|
||||
|
||||
if(files.indexOf(".git") === -1){
|
||||
console.error("No .git folder, aborting");
|
||||
if (files.indexOf('.git') === -1) {
|
||||
console.error('No .git folder, aborting');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
// do a git pull...
|
||||
var child_process = require('child_process');
|
||||
try{
|
||||
child_process.execSync('git pull ',{"cwd":pluginPath+"/"});
|
||||
}catch(e){
|
||||
console.error("Error git pull", e);
|
||||
};
|
||||
try {
|
||||
child_process.execSync('git pull ', {cwd: `${pluginPath}/`});
|
||||
} catch (e) {
|
||||
console.error('Error git pull', e);
|
||||
}
|
||||
|
||||
try {
|
||||
const path = pluginPath + '/.github/workflows/npmpublish.yml';
|
||||
const path = `${pluginPath}/.github/workflows/npmpublish.yml`;
|
||||
if (!fs.existsSync(path)) {
|
||||
console.log('no .github/workflows/npmpublish.yml, create one and set npm secret to auto publish to npm on commit');
|
||||
if (autoFix) {
|
||||
const npmpublish =
|
||||
fs.readFileSync('bin/plugins/lib/npmpublish.yml', {encoding: 'utf8', flag: 'r'});
|
||||
fs.mkdirSync(pluginPath + '/.github/workflows', {recursive: true});
|
||||
fs.mkdirSync(`${pluginPath}/.github/workflows`, {recursive: true});
|
||||
fs.writeFileSync(path, npmpublish);
|
||||
hasAutoFixed = true;
|
||||
console.log("If you haven't already, setup autopublish for this plugin https://github.com/ether/etherpad-lite/wiki/Plugins:-Automatically-publishing-to-npm-on-commit-to-Github-Repo");
|
||||
} else {
|
||||
console.log('Setup autopublish for this plugin https://github.com/ether/etherpad-lite/wiki/Plugins:-Automatically-publishing-to-npm-on-commit-to-Github-Repo');
|
||||
}
|
||||
}else{
|
||||
} else {
|
||||
// autopublish exists, we should check the version..
|
||||
// checkVersion takes two file paths and checks for a version string in them.
|
||||
const currVersionFile = fs.readFileSync(path, {encoding: 'utf8', flag: 'r'});
|
||||
const existingConfigLocation = currVersionFile.indexOf("##ETHERPAD_NPM_V=");
|
||||
const existingValue = parseInt(currVersionFile.substr(existingConfigLocation+17, existingConfigLocation.length));
|
||||
const existingConfigLocation = currVersionFile.indexOf('##ETHERPAD_NPM_V=');
|
||||
const existingValue = parseInt(currVersionFile.substr(existingConfigLocation + 17, existingConfigLocation.length));
|
||||
|
||||
const reqVersionFile = fs.readFileSync('bin/plugins/lib/npmpublish.yml', {encoding: 'utf8', flag: 'r'});
|
||||
const reqConfigLocation = reqVersionFile.indexOf("##ETHERPAD_NPM_V=");
|
||||
const reqValue = parseInt(reqVersionFile.substr(reqConfigLocation+17, reqConfigLocation.length));
|
||||
const reqConfigLocation = reqVersionFile.indexOf('##ETHERPAD_NPM_V=');
|
||||
const reqValue = parseInt(reqVersionFile.substr(reqConfigLocation + 17, reqConfigLocation.length));
|
||||
|
||||
if(!existingValue || (reqValue > existingValue)){
|
||||
if (!existingValue || (reqValue > existingValue)) {
|
||||
const npmpublish =
|
||||
fs.readFileSync('bin/plugins/lib/npmpublish.yml', {encoding: 'utf8', flag: 'r'});
|
||||
fs.mkdirSync(pluginPath + '/.github/workflows', {recursive: true});
|
||||
fs.mkdirSync(`${pluginPath}/.github/workflows`, {recursive: true});
|
||||
fs.writeFileSync(path, npmpublish);
|
||||
hasAutoFixed = true;
|
||||
}
|
||||
|
|
@ -107,152 +107,151 @@ fs.readdir(pluginPath, function (err, rootFiles) {
|
|||
console.error(err);
|
||||
}
|
||||
|
||||
if(files.indexOf("package.json") === -1){
|
||||
console.warn("no package.json, please create");
|
||||
if (files.indexOf('package.json') === -1) {
|
||||
console.warn('no package.json, please create');
|
||||
}
|
||||
|
||||
if(files.indexOf("package.json") !== -1){
|
||||
let packageJSON = fs.readFileSync(pluginPath+"/package.json", {encoding:'utf8', flag:'r'});
|
||||
let parsedPackageJSON = JSON.parse(packageJSON);
|
||||
if(autoFix){
|
||||
var updatedPackageJSON = false;
|
||||
if(!parsedPackageJSON.funding){
|
||||
if (files.indexOf('package.json') !== -1) {
|
||||
const packageJSON = fs.readFileSync(`${pluginPath}/package.json`, {encoding: 'utf8', flag: 'r'});
|
||||
const parsedPackageJSON = JSON.parse(packageJSON);
|
||||
if (autoFix) {
|
||||
let updatedPackageJSON = false;
|
||||
if (!parsedPackageJSON.funding) {
|
||||
updatedPackageJSON = true;
|
||||
parsedPackageJSON.funding = {
|
||||
"type": "individual",
|
||||
"url": "http://etherpad.org/"
|
||||
}
|
||||
type: 'individual',
|
||||
url: 'http://etherpad.org/',
|
||||
};
|
||||
}
|
||||
if(updatedPackageJSON){
|
||||
if (updatedPackageJSON) {
|
||||
hasAutoFixed = true;
|
||||
fs.writeFileSync(pluginPath+"/package.json", JSON.stringify(parsedPackageJSON, null, 2));
|
||||
fs.writeFileSync(`${pluginPath}/package.json`, JSON.stringify(parsedPackageJSON, null, 2));
|
||||
}
|
||||
}
|
||||
|
||||
if(packageJSON.toLowerCase().indexOf("repository") === -1){
|
||||
console.warn("No repository in package.json");
|
||||
if(autoFix){
|
||||
console.warn("Repository not detected in package.json. Please add repository section manually.")
|
||||
if (packageJSON.toLowerCase().indexOf('repository') === -1) {
|
||||
console.warn('No repository in package.json');
|
||||
if (autoFix) {
|
||||
console.warn('Repository not detected in package.json. Please add repository section manually.');
|
||||
}
|
||||
}else{
|
||||
} else {
|
||||
// useful for creating README later.
|
||||
repository = parsedPackageJSON.repository.url;
|
||||
}
|
||||
|
||||
// include lint config
|
||||
if(packageJSON.toLowerCase().indexOf("devdependencies") === -1 || !parsedPackageJSON.devDependencies.eslint){
|
||||
console.warn("Missing eslint reference in devDependencies");
|
||||
if(autoFix){
|
||||
let devDependencies = {
|
||||
"eslint": "^7.14.0",
|
||||
"eslint-config-etherpad": "^1.0.10",
|
||||
"eslint-plugin-mocha": "^8.0.0",
|
||||
"eslint-plugin-node": "^11.1.0",
|
||||
"eslint-plugin-prefer-arrow": "^1.2.2",
|
||||
"eslint-plugin-promise": "^4.2.1"
|
||||
}
|
||||
if (packageJSON.toLowerCase().indexOf('devdependencies') === -1 || !parsedPackageJSON.devDependencies.eslint) {
|
||||
console.warn('Missing eslint reference in devDependencies');
|
||||
if (autoFix) {
|
||||
const devDependencies = {
|
||||
'eslint': '^7.14.0',
|
||||
'eslint-config-etherpad': '^1.0.10',
|
||||
'eslint-plugin-mocha': '^8.0.0',
|
||||
'eslint-plugin-node': '^11.1.0',
|
||||
'eslint-plugin-prefer-arrow': '^1.2.2',
|
||||
'eslint-plugin-promise': '^4.2.1',
|
||||
};
|
||||
hasAutoFixed = true;
|
||||
parsedPackageJSON.devDependencies = devDependencies;
|
||||
fs.writeFileSync(pluginPath+"/package.json", JSON.stringify(parsedPackageJSON, null, 2));
|
||||
fs.writeFileSync(`${pluginPath}/package.json`, JSON.stringify(parsedPackageJSON, null, 2));
|
||||
|
||||
let child_process = require('child_process');
|
||||
try{
|
||||
child_process.execSync('npm install',{"cwd":pluginPath+"/"});
|
||||
const child_process = require('child_process');
|
||||
try {
|
||||
child_process.execSync('npm install', {cwd: `${pluginPath}/`});
|
||||
hasAutoFixed = true;
|
||||
}catch(e){
|
||||
console.error("Failed to create package-lock.json");
|
||||
} catch (e) {
|
||||
console.error('Failed to create package-lock.json');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if(packageJSON.toLowerCase().indexOf("eslintconfig") === -1){
|
||||
console.warn("No esLintConfig in package.json");
|
||||
if(autoFix){
|
||||
let eslintConfig = {
|
||||
"root": true,
|
||||
"extends": "etherpad/plugin"
|
||||
}
|
||||
if (packageJSON.toLowerCase().indexOf('eslintconfig') === -1) {
|
||||
console.warn('No esLintConfig in package.json');
|
||||
if (autoFix) {
|
||||
const eslintConfig = {
|
||||
root: true,
|
||||
extends: 'etherpad/plugin',
|
||||
};
|
||||
hasAutoFixed = true;
|
||||
parsedPackageJSON.eslintConfig = eslintConfig;
|
||||
fs.writeFileSync(pluginPath+"/package.json", JSON.stringify(parsedPackageJSON, null, 2));
|
||||
fs.writeFileSync(`${pluginPath}/package.json`, JSON.stringify(parsedPackageJSON, null, 2));
|
||||
}
|
||||
}
|
||||
|
||||
if(packageJSON.toLowerCase().indexOf("scripts") === -1){
|
||||
console.warn("No scripts in package.json");
|
||||
if(autoFix){
|
||||
let scripts = {
|
||||
"lint": "eslint .",
|
||||
"lint:fix": "eslint --fix ."
|
||||
}
|
||||
if (packageJSON.toLowerCase().indexOf('scripts') === -1) {
|
||||
console.warn('No scripts in package.json');
|
||||
if (autoFix) {
|
||||
const scripts = {
|
||||
'lint': 'eslint .',
|
||||
'lint:fix': 'eslint --fix .',
|
||||
};
|
||||
hasAutoFixed = true;
|
||||
parsedPackageJSON.scripts = scripts;
|
||||
fs.writeFileSync(pluginPath+"/package.json", JSON.stringify(parsedPackageJSON, null, 2));
|
||||
fs.writeFileSync(`${pluginPath}/package.json`, JSON.stringify(parsedPackageJSON, null, 2));
|
||||
}
|
||||
}
|
||||
|
||||
if(packageJSON.toLowerCase().indexOf("engines") === -1){
|
||||
console.warn("No engines in package.json");
|
||||
if(autoFix){
|
||||
let engines = {
|
||||
"lint": "eslint ."
|
||||
}
|
||||
if (packageJSON.toLowerCase().indexOf('engines') === -1) {
|
||||
console.warn('No engines in package.json');
|
||||
if (autoFix) {
|
||||
const engines = {
|
||||
lint: 'eslint .',
|
||||
};
|
||||
hasAutoFixed = true;
|
||||
parsedPackageJSON.engines = engines;
|
||||
fs.writeFileSync(pluginPath+"/package.json", JSON.stringify(parsedPackageJSON, null, 2));
|
||||
fs.writeFileSync(`${pluginPath}/package.json`, JSON.stringify(parsedPackageJSON, null, 2));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
if(files.indexOf("package-lock.json") === -1){
|
||||
console.warn("package-lock.json file not found. Please run npm install in the plugin folder and commit the package-lock.json file.")
|
||||
if(autoFix){
|
||||
if (files.indexOf('package-lock.json') === -1) {
|
||||
console.warn('package-lock.json file not found. Please run npm install in the plugin folder and commit the package-lock.json file.');
|
||||
if (autoFix) {
|
||||
var child_process = require('child_process');
|
||||
try{
|
||||
child_process.execSync('npm install',{"cwd":pluginPath+"/"});
|
||||
console.log("Making package-lock.json");
|
||||
try {
|
||||
child_process.execSync('npm install', {cwd: `${pluginPath}/`});
|
||||
console.log('Making package-lock.json');
|
||||
hasAutoFixed = true;
|
||||
}catch(e){
|
||||
console.error("Failed to create package-lock.json");
|
||||
} catch (e) {
|
||||
console.error('Failed to create package-lock.json');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if(files.indexOf("readme") === -1 && files.indexOf("readme.md") === -1){
|
||||
console.warn("README.md file not found, please create");
|
||||
if(autoFix){
|
||||
console.log("Autofixing missing README.md file, please edit the README.md file further to include plugin specific details.");
|
||||
let readme = fs.readFileSync("bin/plugins/lib/README.md", {encoding:'utf8', flag:'r'})
|
||||
if (files.indexOf('readme') === -1 && files.indexOf('readme.md') === -1) {
|
||||
console.warn('README.md file not found, please create');
|
||||
if (autoFix) {
|
||||
console.log('Autofixing missing README.md file, please edit the README.md file further to include plugin specific details.');
|
||||
let readme = fs.readFileSync('bin/plugins/lib/README.md', {encoding: 'utf8', flag: 'r'});
|
||||
readme = readme.replace(/\[plugin_name\]/g, pluginName);
|
||||
if(repository){
|
||||
let org = repository.split("/")[3];
|
||||
let name = repository.split("/")[4];
|
||||
if (repository) {
|
||||
const org = repository.split('/')[3];
|
||||
const name = repository.split('/')[4];
|
||||
readme = readme.replace(/\[org_name\]/g, org);
|
||||
readme = readme.replace(/\[repo_url\]/g, name);
|
||||
fs.writeFileSync(pluginPath+"/README.md", readme);
|
||||
}else{
|
||||
console.warn("Unable to find repository in package.json, aborting.")
|
||||
fs.writeFileSync(`${pluginPath}/README.md`, readme);
|
||||
} else {
|
||||
console.warn('Unable to find repository in package.json, aborting.');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if(files.indexOf("readme") !== -1 && files.indexOf("readme.md") !== -1){
|
||||
let readme = fs.readFileSync(pluginPath+"/"+readMeFileName, {encoding:'utf8', flag:'r'});
|
||||
if(readme.toLowerCase().indexOf("license") === -1){
|
||||
console.warn("No license section in README");
|
||||
if(autoFix){
|
||||
console.warn("Please add License section to README manually.")
|
||||
if (files.indexOf('readme') !== -1 && files.indexOf('readme.md') !== -1) {
|
||||
const readme = fs.readFileSync(`${pluginPath}/${readMeFileName}`, {encoding: 'utf8', flag: 'r'});
|
||||
if (readme.toLowerCase().indexOf('license') === -1) {
|
||||
console.warn('No license section in README');
|
||||
if (autoFix) {
|
||||
console.warn('Please add License section to README manually.');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if(files.indexOf("license") === -1 && files.indexOf("license.md") === -1){
|
||||
console.warn("LICENSE.md file not found, please create");
|
||||
if(autoFix){
|
||||
if (files.indexOf('license') === -1 && files.indexOf('license.md') === -1) {
|
||||
console.warn('LICENSE.md file not found, please create');
|
||||
if (autoFix) {
|
||||
hasAutoFixed = true;
|
||||
console.log("Autofixing missing LICENSE.md file, including Apache 2 license.");
|
||||
exec("git config user.name", (error, name, stderr) => {
|
||||
console.log('Autofixing missing LICENSE.md file, including Apache 2 license.');
|
||||
exec('git config user.name', (error, name, stderr) => {
|
||||
if (error) {
|
||||
console.log(`error: ${error.message}`);
|
||||
return;
|
||||
|
|
@ -261,120 +260,118 @@ fs.readdir(pluginPath, function (err, rootFiles) {
|
|||
console.log(`stderr: ${stderr}`);
|
||||
return;
|
||||
}
|
||||
let license = fs.readFileSync("bin/plugins/lib/LICENSE.md", {encoding:'utf8', flag:'r'});
|
||||
license = license.replace("[yyyy]", new Date().getFullYear());
|
||||
license = license.replace("[name of copyright owner]", name)
|
||||
fs.writeFileSync(pluginPath+"/LICENSE.md", license);
|
||||
let license = fs.readFileSync('bin/plugins/lib/LICENSE.md', {encoding: 'utf8', flag: 'r'});
|
||||
license = license.replace('[yyyy]', new Date().getFullYear());
|
||||
license = license.replace('[name of copyright owner]', name);
|
||||
fs.writeFileSync(`${pluginPath}/LICENSE.md`, license);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
var travisConfig = fs.readFileSync("bin/plugins/lib/travis.yml", {encoding:'utf8', flag:'r'});
|
||||
let travisConfig = fs.readFileSync('bin/plugins/lib/travis.yml', {encoding: 'utf8', flag: 'r'});
|
||||
travisConfig = travisConfig.replace(/\[plugin_name\]/g, pluginName);
|
||||
|
||||
if(files.indexOf(".travis.yml") === -1){
|
||||
console.warn(".travis.yml file not found, please create. .travis.yml is used for automatically CI testing Etherpad. It is useful to know if your plugin breaks another feature for example.")
|
||||
if (files.indexOf('.travis.yml') === -1) {
|
||||
console.warn('.travis.yml file not found, please create. .travis.yml is used for automatically CI testing Etherpad. It is useful to know if your plugin breaks another feature for example.');
|
||||
// TODO: Make it check version of the .travis file to see if it needs an update.
|
||||
if(autoFix){
|
||||
if (autoFix) {
|
||||
hasAutoFixed = true;
|
||||
console.log("Autofixing missing .travis.yml file");
|
||||
fs.writeFileSync(pluginPath+"/.travis.yml", travisConfig);
|
||||
console.log("Travis file created, please sign into travis and enable this repository")
|
||||
console.log('Autofixing missing .travis.yml file');
|
||||
fs.writeFileSync(`${pluginPath}/.travis.yml`, travisConfig);
|
||||
console.log('Travis file created, please sign into travis and enable this repository');
|
||||
}
|
||||
}
|
||||
if(autoFix && autoUpdate){
|
||||
if (autoFix && autoUpdate) {
|
||||
// checks the file versioning of .travis and updates it to the latest.
|
||||
let existingConfig = fs.readFileSync(pluginPath + "/.travis.yml", {encoding:'utf8', flag:'r'});
|
||||
let existingConfigLocation = existingConfig.indexOf("##ETHERPAD_TRAVIS_V=");
|
||||
let existingValue = parseInt(existingConfig.substr(existingConfigLocation+20, existingConfig.length));
|
||||
const existingConfig = fs.readFileSync(`${pluginPath}/.travis.yml`, {encoding: 'utf8', flag: 'r'});
|
||||
const existingConfigLocation = existingConfig.indexOf('##ETHERPAD_TRAVIS_V=');
|
||||
const existingValue = parseInt(existingConfig.substr(existingConfigLocation + 20, existingConfig.length));
|
||||
|
||||
let newConfigLocation = travisConfig.indexOf("##ETHERPAD_TRAVIS_V=");
|
||||
let newValue = parseInt(travisConfig.substr(newConfigLocation+20, travisConfig.length));
|
||||
if(existingConfigLocation === -1){
|
||||
console.warn("no previous .travis.yml version found so writing new.")
|
||||
const newConfigLocation = travisConfig.indexOf('##ETHERPAD_TRAVIS_V=');
|
||||
const newValue = parseInt(travisConfig.substr(newConfigLocation + 20, travisConfig.length));
|
||||
if (existingConfigLocation === -1) {
|
||||
console.warn('no previous .travis.yml version found so writing new.');
|
||||
// we will write the newTravisConfig to the location.
|
||||
fs.writeFileSync(pluginPath + "/.travis.yml", travisConfig);
|
||||
}else{
|
||||
if(newValue > existingValue){
|
||||
console.log("updating .travis.yml");
|
||||
fs.writeFileSync(pluginPath + "/.travis.yml", travisConfig);
|
||||
hasAutoFixed = true;
|
||||
}
|
||||
fs.writeFileSync(`${pluginPath}/.travis.yml`, travisConfig);
|
||||
} else if (newValue > existingValue) {
|
||||
console.log('updating .travis.yml');
|
||||
fs.writeFileSync(`${pluginPath}/.travis.yml`, travisConfig);
|
||||
hasAutoFixed = true;
|
||||
}
|
||||
}
|
||||
|
||||
if(files.indexOf(".gitignore") === -1){
|
||||
console.warn(".gitignore file not found, please create. .gitignore files are useful to ensure files aren't incorrectly commited to a repository.")
|
||||
if(autoFix){
|
||||
if (files.indexOf('.gitignore') === -1) {
|
||||
console.warn(".gitignore file not found, please create. .gitignore files are useful to ensure files aren't incorrectly commited to a repository.");
|
||||
if (autoFix) {
|
||||
hasAutoFixed = true;
|
||||
console.log("Autofixing missing .gitignore file");
|
||||
let gitignore = fs.readFileSync("bin/plugins/lib/gitignore", {encoding:'utf8', flag:'r'});
|
||||
fs.writeFileSync(pluginPath+"/.gitignore", gitignore);
|
||||
console.log('Autofixing missing .gitignore file');
|
||||
const gitignore = fs.readFileSync('bin/plugins/lib/gitignore', {encoding: 'utf8', flag: 'r'});
|
||||
fs.writeFileSync(`${pluginPath}/.gitignore`, gitignore);
|
||||
}
|
||||
}
|
||||
|
||||
// if we include templates but don't have translations...
|
||||
if(files.indexOf("templates") !== -1 && files.indexOf("locales") === -1){
|
||||
console.warn("Translations not found, please create. Translation files help with Etherpad accessibility.");
|
||||
if (files.indexOf('templates') !== -1 && files.indexOf('locales') === -1) {
|
||||
console.warn('Translations not found, please create. Translation files help with Etherpad accessibility.');
|
||||
}
|
||||
|
||||
|
||||
if(files.indexOf(".ep_initialized") !== -1){
|
||||
console.warn(".ep_initialized found, please remove. .ep_initialized should never be commited to git and should only exist once the plugin has been executed one time.")
|
||||
if(autoFix){
|
||||
if (files.indexOf('.ep_initialized') !== -1) {
|
||||
console.warn('.ep_initialized found, please remove. .ep_initialized should never be commited to git and should only exist once the plugin has been executed one time.');
|
||||
if (autoFix) {
|
||||
hasAutoFixed = true;
|
||||
console.log("Autofixing incorrectly existing .ep_initialized file");
|
||||
fs.unlinkSync(pluginPath+"/.ep_initialized");
|
||||
console.log('Autofixing incorrectly existing .ep_initialized file');
|
||||
fs.unlinkSync(`${pluginPath}/.ep_initialized`);
|
||||
}
|
||||
}
|
||||
|
||||
if(files.indexOf("npm-debug.log") !== -1){
|
||||
console.warn("npm-debug.log found, please remove. npm-debug.log should never be commited to your repository.")
|
||||
if(autoFix){
|
||||
if (files.indexOf('npm-debug.log') !== -1) {
|
||||
console.warn('npm-debug.log found, please remove. npm-debug.log should never be commited to your repository.');
|
||||
if (autoFix) {
|
||||
hasAutoFixed = true;
|
||||
console.log("Autofixing incorrectly existing npm-debug.log file");
|
||||
fs.unlinkSync(pluginPath+"/npm-debug.log");
|
||||
console.log('Autofixing incorrectly existing npm-debug.log file');
|
||||
fs.unlinkSync(`${pluginPath}/npm-debug.log`);
|
||||
}
|
||||
}
|
||||
|
||||
if(files.indexOf("static") !== -1){
|
||||
fs.readdir(pluginPath+"/static", function (errRead, staticFiles) {
|
||||
if(staticFiles.indexOf("tests") === -1){
|
||||
console.warn("Test files not found, please create tests. https://github.com/ether/etherpad-lite/wiki/Creating-a-plugin#writing-and-running-front-end-tests-for-your-plugin")
|
||||
if (files.indexOf('static') !== -1) {
|
||||
fs.readdir(`${pluginPath}/static`, (errRead, staticFiles) => {
|
||||
if (staticFiles.indexOf('tests') === -1) {
|
||||
console.warn('Test files not found, please create tests. https://github.com/ether/etherpad-lite/wiki/Creating-a-plugin#writing-and-running-front-end-tests-for-your-plugin');
|
||||
}
|
||||
})
|
||||
}else{
|
||||
console.warn("Test files not found, please create tests. https://github.com/ether/etherpad-lite/wiki/Creating-a-plugin#writing-and-running-front-end-tests-for-your-plugin")
|
||||
});
|
||||
} else {
|
||||
console.warn('Test files not found, please create tests. https://github.com/ether/etherpad-lite/wiki/Creating-a-plugin#writing-and-running-front-end-tests-for-your-plugin');
|
||||
}
|
||||
|
||||
// linting begins
|
||||
if(autoFix){
|
||||
if (autoFix) {
|
||||
var lintCmd = 'npm run lint:fix';
|
||||
}else{
|
||||
} else {
|
||||
var lintCmd = 'npm run lint';
|
||||
}
|
||||
|
||||
try{
|
||||
child_process.execSync(lintCmd,{"cwd":pluginPath+"/"});
|
||||
console.log("Linting...");
|
||||
if(autoFix){
|
||||
try {
|
||||
child_process.execSync(lintCmd, {cwd: `${pluginPath}/`});
|
||||
console.log('Linting...');
|
||||
if (autoFix) {
|
||||
// todo: if npm run lint doesn't do anything no need for...
|
||||
hasAutoFixed = true;
|
||||
}
|
||||
}catch(e){
|
||||
} catch (e) {
|
||||
// it is gonna throw an error anyway
|
||||
console.log("Manual linting probably required, check with: npm run lint");
|
||||
console.log('Manual linting probably required, check with: npm run lint');
|
||||
}
|
||||
// linting ends.
|
||||
|
||||
if(hasAutoFixed){
|
||||
console.log("Fixes applied, please check git diff then run the following command:\n\n")
|
||||
if (hasAutoFixed) {
|
||||
console.log('Fixes applied, please check git diff then run the following command:\n\n');
|
||||
// bump npm Version
|
||||
if(autoCommit){
|
||||
if (autoCommit) {
|
||||
// holy shit you brave.
|
||||
console.log("Attempting autocommit and auto publish to npm")
|
||||
console.log('Attempting autocommit and auto publish to npm');
|
||||
// github should push to npm for us :)
|
||||
exec("cd node_modules/"+ pluginName + " && git add -A && git commit --allow-empty -m 'autofixes from Etherpad checkPlugins.js' && git push && cd ../..", (error, name, stderr) => {
|
||||
exec(`cd node_modules/${pluginName} && git add -A && git commit --allow-empty -m 'autofixes from Etherpad checkPlugins.js' && git push && cd ../..`, (error, name, stderr) => {
|
||||
if (error) {
|
||||
console.log(`error: ${error.message}`);
|
||||
return;
|
||||
|
|
@ -383,14 +380,13 @@ fs.readdir(pluginPath, function (err, rootFiles) {
|
|||
console.log(`stderr: ${stderr}`);
|
||||
return;
|
||||
}
|
||||
console.log("I think she's got it! By George she's got it!")
|
||||
process.exit(0)
|
||||
console.log("I think she's got it! By George she's got it!");
|
||||
process.exit(0);
|
||||
});
|
||||
}else{
|
||||
console.log("cd node_modules/"+ pluginName + " && git add -A && git commit --allow-empty -m 'autofixes from Etherpad checkPlugins.js' && npm version patch && git add package.json && git commit --allow-empty -m 'bump version' && git push && npm publish && cd ../..")
|
||||
} else {
|
||||
console.log(`cd node_modules/${pluginName} && git add -A && git commit --allow-empty -m 'autofixes from Etherpad checkPlugins.js' && npm version patch && git add package.json && git commit --allow-empty -m 'bump version' && git push && npm publish && cd ../..`);
|
||||
}
|
||||
}
|
||||
|
||||
console.log("Finished");
|
||||
|
||||
console.log('Finished');
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue