Documentation updates for node-red and runtime modules

This commit is contained in:
Nick O'Leary
2018-11-30 23:01:09 +00:00
parent bc02c9573c
commit 0b5e4f2dd7
19 changed files with 256 additions and 190 deletions

View File

@@ -26,7 +26,7 @@ var defaultFileSet = require("./defaultFileSet");
var sshKeys = require("./ssh");
var settings;
var runtime;
var log;
var log = require("@node-red/util").log;
var projectsDir;
@@ -162,7 +162,7 @@ Project.prototype.initialise = function(user,data) {
if (defaultFileSet.hasOwnProperty(file)) {
var path = fspath.join(project.path,file);
if (!fs.existsSync(path)) {
promises.push(util.writeFile(path,defaultFileSet[file](project, runtime)));
promises.push(util.writeFile(path,defaultFileSet[file](project)));
}
}
@@ -858,7 +858,7 @@ function createDefaultProject(user, project) {
}
for (var file in defaultFileSet) {
if (defaultFileSet.hasOwnProperty(file)) {
promises.push(util.writeFile(fspath.join(projectPath,file),defaultFileSet[file](project, runtime)));
promises.push(util.writeFile(fspath.join(projectPath,file),defaultFileSet[file](project)));
}
}
@@ -992,7 +992,6 @@ function loadProject(projectPath) {
function init(_settings, _runtime) {
settings = _settings;
runtime = _runtime;
log = runtime.log;
projectsDir = fspath.join(settings.userDir,"projects");
authCache.init();
}

View File

@@ -14,9 +14,10 @@
* limitations under the License.
**/
var i18n = require("@node-red/util").i18n;
module.exports = {
"package.json": function(project, runtime) {
var i18n = runtime.i18n;
"package.json": function(project) {
var package = {
"name": project.name,
"description": project.summary||i18n._("storage.localfilesystem.projects.summary"),
@@ -35,8 +36,7 @@ module.exports = {
}
return JSON.stringify(package,"",4);
},
"README.md": function(project, runtime) {
var i18n = runtime.i18n;
"README.md": function(project) {
var content = project.name+"\n"+("=".repeat(project.name.length))+"\n\n";
if (project.summary) {
content += project.summary+"\n\n";

View File

@@ -25,7 +25,7 @@ var path = require("path");
var gitCommand = "git";
var gitVersion;
var log;
var log = require("@node-red/util").log;
function runGitCommand(args,cwd,env,emit) {
log.trace(gitCommand + JSON.stringify(args));
@@ -382,8 +382,7 @@ function removeRemote(cwd,name) {
}
module.exports = {
init: function(_settings,_runtime) {
log = _runtime.log
init: function(_settings) {
return new Promise(function(resolve,reject) {
Promise.all([
runGitCommand(["--version"]),

View File

@@ -29,7 +29,7 @@ var Projects = require("./Project");
var settings;
var runtime;
var log;
var log = require("@node-red/util").log;
var projectsEnabled = false;
var projectLogMessages = [];
@@ -42,7 +42,6 @@ var globalGitUser = false;
function init(_settings, _runtime) {
settings = _settings;
runtime = _runtime;
log = runtime.log;
try {
if (settings.editorTheme.projects.enabled === true) {
@@ -90,7 +89,7 @@ function init(_settings, _runtime) {
if (projectsEnabled) {
return sshTools.init(settings,runtime).then(function() {
gitTools.init(_settings, _runtime).then(function(gitConfig) {
gitTools.init(_settings).then(function(gitConfig) {
if (!gitConfig || /^1\./.test(gitConfig.version)) {
if (!gitConfig) {
projectLogMessages.push(log._("storage.localfilesystem.projects.git-not-found"))
@@ -109,7 +108,7 @@ function init(_settings, _runtime) {
} else {
globalGitUser = gitConfig.user;
Projects.init(settings,runtime);
sshTools.init(settings,runtime);
sshTools.init(settings);
projectsDir = fspath.join(settings.userDir,"projects");
if (!settings.readOnly) {
return fs.ensureDir(projectsDir)

View File

@@ -20,15 +20,12 @@ var fspath = require("path");
var keygen = require("./keygen");
var settings;
var runtime;
var log;
var log = require("@node-red/util").log;
var sshkeyDir;
var userSSHKeyDir;
function init(_settings, _runtime) {
function init(_settings) {
settings = _settings;
runtime = _runtime;
log = runtime.log;
sshkeyDir = fspath.resolve(fspath.join(settings.userDir, "projects", ".sshkeys"));
userSSHKeyDir = fspath.join(process.env.HOME || process.env.USERPROFILE || process.env.HOMEPATH, ".ssh");
// console.log('sshkeys.init()');

View File

@@ -18,7 +18,7 @@ var child_process = require('child_process');
var sshkeygenCommand = "ssh-keygen";
var log;
var log = require("@node-red/util").log;
function runSshKeygenCommand(args,cwd,env) {
return new Promise(function(resolve, reject) {
@@ -54,10 +54,6 @@ function runSshKeygenCommand(args,cwd,env) {
});
}
function init(_settings, _runtime) {
log = _runtime.log;
}
function generateKey(options) {
var args = ['-q', '-t', 'rsa'];
var err;
@@ -90,6 +86,5 @@ function generateKey(options) {
}
module.exports = {
init: init,
generateKey: generateKey,
generateKey: generateKey
};