Skip to content

Commit

Permalink
fix: correct all the spelling typos (#3960)
Browse files Browse the repository at this point in the history
* Improve code health
Fix TS typos in local variables
Fix CSS typos in local styles
Fix typos in comments
Fix typos in strings

* Fix order of n8n setup sections in CONTRIBUTING.md
  • Loading branch information
delasy authored Sep 2, 2022
1 parent a3791c2 commit 49c85a1
Showing 69 changed files with 164 additions and 164 deletions.
2 changes: 1 addition & 1 deletion .vscode/DEBUGGER.md
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@ Breakpoints are noted with a red dot in front of the line, meaning that whenever

## What if I change the code?

You might need to restart the debugger if you make changes to your code, since the running process will be executing an oudated version of the code.
You might need to restart the debugger if you make changes to your code, since the running process will be executing an outdated version of the code.

In order to make this process easier you can simply run `npm run watch` in another terminal window, so you don't have to fully build the project. Please note that restarting n8n is still required, but this is much faster.

8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -97,16 +97,16 @@ checked out and set up:
git clone https://github.com/<your_github_username>/n8n.git
```

3. Add the original n8n repository as `upstream` to your forked repository
3. Go into repository folder

```
git remote add upstream https://github.com/n8n-io/n8n.git
cd n8n
```

4. Go into repository folder
4. Add the original n8n repository as `upstream` to your forked repository

```
cd n8n
git remote add upstream https://github.com/n8n-io/n8n.git
```

5. Install all dependencies of all modules and link them together:
2 changes: 1 addition & 1 deletion docker/compose/subfolderWithSSL/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# n8n on Subfolder with SSL

Starts n8n and deployes it on a subfolder
Starts n8n and deploys it on a subfolder

## Start

2 changes: 1 addition & 1 deletion packages/cli/commands/Interfaces.d.ts
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ interface IResult {
interface IExecutionResult {
workflowId: string | number;
workflowName: string;
executionTime: number; // Given in seconds with decimals for milisseconds
executionTime: number; // Given in seconds with decimals for milliseconds
finished: boolean;
executionStatus: ExecutionStatus;
error?: string;
6 changes: 3 additions & 3 deletions packages/cli/commands/executeBatch.ts
Original file line number Diff line number Diff line change
@@ -98,7 +98,7 @@ export class ExecuteBatch extends Command {
}),
shallow: flags.boolean({
description:
'Compares only if attributes output from node are the same, with no regards to neste JSON objects.',
'Compares only if attributes output from node are the same, with no regards to nested JSON objects.',
}),
skipList: flags.string({
description: 'File containing a comma separated list of workflow IDs to skip.',
@@ -152,7 +152,7 @@ export class ExecuteBatch extends Command {
executingWorkflows = activeExecutionsInstance.getActiveExecutions();
}
// We may receive true but when called from `process.on`
// we get the signal (SIGNIT, etc.)
// we get the signal (SIGINT, etc.)
if (skipExit !== true) {
process.exit(0);
}
@@ -864,7 +864,7 @@ export class ExecuteBatch extends Command {
}
}
// Save snapshots only after comparing - this is to make sure we're updating
// After comparing to existing verion.
// After comparing to existing version.
if (ExecuteBatch.snapshot !== undefined) {
const fileName = `${
ExecuteBatch.snapshot.endsWith(sep)
4 changes: 2 additions & 2 deletions packages/cli/commands/export/credentials.ts
Original file line number Diff line number Diff line change
@@ -86,7 +86,7 @@ export class ExportCredentialsCommand extends Command {

if (fs.existsSync(flags.output)) {
if (!fs.lstatSync(flags.output).isDirectory()) {
console.info(`The paramenter --output must be a directory`);
console.info(`The parameter --output must be a directory`);
return;
}
} else {
@@ -105,7 +105,7 @@ export class ExportCredentialsCommand extends Command {
} else if (flags.output) {
if (fs.existsSync(flags.output)) {
if (fs.lstatSync(flags.output).isDirectory()) {
console.info(`The paramenter --output must be a writeble file`);
console.info(`The parameter --output must be a writeable file`);
return;
}
}
4 changes: 2 additions & 2 deletions packages/cli/commands/export/workflow.ts
Original file line number Diff line number Diff line change
@@ -78,7 +78,7 @@ export class ExportWorkflowsCommand extends Command {

if (fs.existsSync(flags.output)) {
if (!fs.lstatSync(flags.output).isDirectory()) {
console.info(`The paramenter --output must be a directory`);
console.info(`The parameter --output must be a directory`);
return;
}
} else {
@@ -97,7 +97,7 @@ export class ExportWorkflowsCommand extends Command {
} else if (flags.output) {
if (fs.existsSync(flags.output)) {
if (fs.lstatSync(flags.output).isDirectory()) {
console.info(`The paramenter --output must be a writeble file`);
console.info(`The parameter --output must be a writeable file`);
return;
}
}
2 changes: 1 addition & 1 deletion packages/cli/commands/start.ts
Original file line number Diff line number Diff line change
@@ -256,7 +256,7 @@ export class Start extends Command {
missingPackages.delete(missingPackage);
}
LoggerProxy.info(
'Packages reinstalled successfully. Resuming regular intiailization.',
'Packages reinstalled successfully. Resuming regular initialization.',
);
} catch (error) {
LoggerProxy.error('n8n was unable to install the missing packages.');
2 changes: 1 addition & 1 deletion packages/cli/commands/webhook.ts
Original file line number Diff line number Diff line change
@@ -106,7 +106,7 @@ export class Webhook extends Command {
* as it is unable to determine if it is still running or crashed
* - You cannot stop currently executing jobs from webhook processes
* when running without queues as the main process cannot talk to
* the wehbook processes to communicate workflow execution interruption.
* the webhook processes to communicate workflow execution interruption.
*/

this.error('Webhook processes can only run with execution mode as queue.');
2 changes: 1 addition & 1 deletion packages/cli/commands/worker.ts
Original file line number Diff line number Diff line change
@@ -391,7 +391,7 @@ export class Worker extends Command {
}

// Just to be complete, generally will the worker stop automatically
// if it loses the conection to redis
// if it loses the connection to redis
try {
// Redis ping
await Worker.jobQueue.client.ping();
10 changes: 5 additions & 5 deletions packages/cli/config/schema.ts
Original file line number Diff line number Diff line change
@@ -151,7 +151,7 @@ export const schema = {
// Allows to set default values for credentials which
// get automatically prefilled and the user does not get
// displayed and can not change.
// Format: { CREDENTIAL_NAME: { PARAMTER: VALUE }}
// Format: { CREDENTIAL_NAME: { PARAMETER: VALUE }}
doc: 'Overwrites for credentials',
format: '*',
default: '{}',
@@ -248,7 +248,7 @@ export const schema = {
env: 'EXECUTIONS_DATA_SAVE_ON_SUCCESS',
},
saveExecutionProgress: {
doc: 'Wether or not to save progress for each node executed',
doc: 'Whether or not to save progress for each node executed',
format: 'Boolean',
default: false,
env: 'EXECUTIONS_DATA_SAVE_ON_PROGRESS',
@@ -363,7 +363,7 @@ export const schema = {
generic: {
// The timezone to use. Is important for nodes like "Cron" which start the
// workflow automatically at a specified time. This setting can also be
// overwritten on a per worfklow basis in the workflow settings in the
// overwritten on a per workflow basis in the workflow settings in the
// editor.
timezone: {
doc: 'The timezone to use',
@@ -607,7 +607,7 @@ export const schema = {
format: Boolean,
default: false,
env: 'N8N_WORKFLOW_TAGS_DISABLED',
doc: 'Disable worfklow tags.',
doc: 'Disable workflow tags.',
},

userManagement: {
@@ -945,7 +945,7 @@ export const schema = {

onboardingCallPrompt: {
enabled: {
doc: 'Whether onboarding call propmpt feature is available',
doc: 'Whether onboarding call prompt feature is available',
format: Boolean,
default: true,
env: 'N8N_ONBOARDING_CALL_PROMPTS_ENABLED',
8 changes: 4 additions & 4 deletions packages/cli/src/ActiveWorkflowRunner.ts
Original file line number Diff line number Diff line change
@@ -75,7 +75,7 @@ export class ActiveWorkflowRunner {

// NOTE
// Here I guess we can have a flag on the workflow table like hasTrigger
// so intead of pulling all the active wehhooks just pull the actives that have a trigger
// so instead of pulling all the active webhooks just pull the actives that have a trigger
const workflowsData: IWorkflowDb[] = (await Db.collections.Workflow.find({
where: { active: true },
relations: ['shared', 'shared.user', 'shared.user.globalRole'],
@@ -183,7 +183,7 @@ export class ActiveWorkflowRunner {
req: express.Request,
res: express.Response,
): Promise<IResponseCallbackData> {
Logger.debug(`Received webhoook "${httpMethod}" for path "${path}"`);
Logger.debug(`Received webhook "${httpMethod}" for path "${path}"`);
if (this.activeWorkflows === null) {
throw new ResponseHelper.ResponseError(
'The "activeWorkflows" instance did not get initialized yet.',
@@ -480,7 +480,7 @@ export class ActiveWorkflowRunner {
config.getEnv('endpoints.skipWebhoooksDeregistrationOnShutdown') &&
error.name === 'QueryFailedError'
) {
// When skipWebhoooksDeregistrationOnShutdown is enabled,
// When skipWebhooksDeregistrationOnShutdown is enabled,
// n8n does not remove the registered webhooks on exit.
// This means that further initializations will always fail
// when inserting to database. This is why we ignore this error
@@ -504,7 +504,7 @@ export class ActiveWorkflowRunner {
if (error.name === 'QueryFailedError') {
error.message = `The URL path that the "${webhook.node}" node uses is already taken. Please change it to something else.`;
} else if (error.detail) {
// it's a error runnig the webhook methods (checkExists, create)
// it's a error running the webhook methods (checkExists, create)
error.message = error.detail;
}

8 changes: 4 additions & 4 deletions packages/cli/src/CredentialsHelper.ts
Original file line number Diff line number Diff line change
@@ -307,7 +307,7 @@ export class CredentialsHelper extends ICredentialsHelper {
NodeHelpers.mergeNodeProperties(combineProperties, mergeCredentialProperties);
}

// The properties defined on the parent credentials take presidence
// The properties defined on the parent credentials take precedence
NodeHelpers.mergeNodeProperties(combineProperties, credentialTypeData.properties);

return combineProperties;
@@ -526,11 +526,11 @@ export class CredentialsHelper extends ICredentialsHelper {
}
}
}
// Test is defined as string which links to a functoin
// Test is defined as string which links to a function
return (node as unknown as INodeType).methods?.credentialTest![credential.testedBy];
}

// Test is defined as JSON with a defintion for the request to make
// Test is defined as JSON with a definition for the request to make
return {
nodeType,
testRequest: credential.testedBy,
@@ -574,7 +574,7 @@ export class CredentialsHelper extends ICredentialsHelper {

// Credentials get tested via request instructions

// TODO: Temp worfklows get created at multiple locations (for example also LoadNodeParameterOptions),
// TODO: Temp workflows get created at multiple locations (for example also LoadNodeParameterOptions),
// check if some of them are identical enough that it can be combined

let nodeType: INodeType;
2 changes: 1 addition & 1 deletion packages/cli/src/GenericHelpers.ts
Original file line number Diff line number Diff line change
@@ -121,7 +121,7 @@ export async function getConfigValue(
return config.getEnv(configKey);
}

// Check if special file enviroment variable exists
// Check if special file environment variable exists
const fileEnvironmentVariable = process.env[`${currentSchema.env}_FILE`];
if (fileEnvironmentVariable === undefined) {
// Does not exist, so return value from config
2 changes: 1 addition & 1 deletion packages/cli/src/Interfaces.ts
Original file line number Diff line number Diff line change
@@ -216,7 +216,7 @@ export interface IExecutionResponse extends IExecutionBase {
workflowData: IWorkflowBase;
}

// Flatted data to save memory when saving in database or transfering
// Flatted data to save memory when saving in database or transferring
// via REST API
export interface IExecutionFlatted extends IExecutionBase {
data: string;
2 changes: 1 addition & 1 deletion packages/cli/src/InternalHooks.ts
Original file line number Diff line number Diff line change
@@ -343,7 +343,7 @@ export class InternalHooksClass implements IInternalHooksClass {
public_api: boolean;
}): Promise<void> {
return this.telemetry.track(
'Instance sent transacptional email to user',
'Instance sent transactional email to user',
userTransactionalEmailData,
);
}
4 changes: 2 additions & 2 deletions packages/cli/src/LoadNodesAndCredentials.ts
Original file line number Diff line number Diff line change
@@ -201,7 +201,7 @@ class LoadNodesAndCredentialsClass {
// Add serializer method "toJSON" to the class so that authenticate method (if defined)
// gets mapped to the authenticate attribute before it is sent to the client.
// The authenticate property is used by the client to decide whether or not to
// include the credential type in the predifined credentials (HTTP node)
// include the credential type in the predefined credentials (HTTP node)
// eslint-disable-next-line func-names
tempModule[credentialName].prototype.toJSON = function () {
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
@@ -426,7 +426,7 @@ class LoadNodesAndCredentialsClass {
return;
}

// Check if the node should be skiped
// Check if the node should be skipped
if (this.excludeNodes !== undefined && this.excludeNodes.includes(fullNodeName)) {
return;
}
2 changes: 1 addition & 1 deletion packages/cli/src/PublicApi/index.ts
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@ function createApiRouter(
): Router {
const n8nPath = config.getEnv('path');
const swaggerDocument = YAML.load(openApiSpecPath) as swaggerUi.JsonObject;
// add the server depeding on the config so the user can interact with the API
// add the server depending on the config so the user can interact with the API
// from the Swagger UI
swaggerDocument.server = [
{
Original file line number Diff line number Diff line change
@@ -137,9 +137,9 @@ export function sanitizeCredentials(

/**
* toJsonSchema
* Take an array of crendentials parameter and map it
* Take an array of credentials parameter and map it
* to a JSON Schema (see https://json-schema.org/). With
* the JSON Schema defintion we can validate the credential's shape
* the JSON Schema definition we can validate the credential's shape
* @param properties - Credentials properties
* @returns The credentials schema definition.
*/
@@ -155,7 +155,7 @@ export function toJsonSchema(properties: INodeProperties[]): IDataObject {
const optionsValues: { [key: string]: string[] } = {};
const resolveProperties: string[] = [];

// get all posible values of properties type "options"
// get all possible values of properties type "options"
// so we can later resolve the displayOptions dependencies
properties
.filter((property) => property.type === 'options')
@@ -177,7 +177,7 @@ export function toJsonSchema(properties: INodeProperties[]): IDataObject {
requiredFields.push(property.name);
if (property.type === 'options') {
// if the property is type options,
// include all possible values in the anum property.
// include all possible values in the enum property.
Object.assign(jsonSchema.properties, {
[property.name]: {
type: 'string',
Original file line number Diff line number Diff line change
@@ -251,7 +251,7 @@ export = {
return res.json(sharedWorkflow.workflow);
}

// nothing to do as the wokflow is already active
// nothing to do as the workflow is already active
return res.json(sharedWorkflow.workflow);
},
],
@@ -280,7 +280,7 @@ export = {
return res.json(sharedWorkflow.workflow);
}

// nothing to do as the wokflow is already inactive
// nothing to do as the workflow is already inactive
return res.json(sharedWorkflow.workflow);
},
],
2 changes: 1 addition & 1 deletion packages/cli/src/Push.ts
Original file line number Diff line number Diff line change
@@ -68,7 +68,7 @@ export class Push {
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
send(type: IPushDataType, data: any, sessionId?: string) {
if (sessionId !== undefined && this.connections[sessionId] === undefined) {
Logger.error(`The session "${sessionId}" is not registred.`, { sessionId });
Logger.error(`The session "${sessionId}" is not registered.`, { sessionId });
return;
}

6 changes: 3 additions & 3 deletions packages/cli/src/Server.ts
Original file line number Diff line number Diff line change
@@ -1748,7 +1748,7 @@ class App {
this.app.all(
`/${this.endpointWebhookTest}/*`,
async (req: express.Request, res: express.Response) => {
// Cut away the "/webhook-test/" to get the registred part of the url
// Cut away the "/webhook-test/" to get the registered part of the url
const requestUrl = (req as ICustomRequest).parsedUrl!.pathname!.slice(
this.endpointWebhookTest.length + 2,
);
@@ -1936,7 +1936,7 @@ export async function start(): Promise<void> {

await app.externalHooks.run('n8n.ready', [app, config]);
const cpus = os.cpus();
const binarDataConfig = config.getEnv('binaryDataManager');
const binaryDataConfig = config.getEnv('binaryDataManager');
const diagnosticInfo: IDiagnosticInfo = {
basicAuthActive: config.getEnv('security.basicAuth.active'),
databaseType: (await GenericHelpers.getConfigValue('database.type')) as DatabaseType,
@@ -1973,7 +1973,7 @@ export async function start(): Promise<void> {
executions_data_prune_timeout: config.getEnv('executions.pruneDataTimeout'),
},
deploymentType: config.getEnv('deployment.type'),
binaryDataMode: binarDataConfig.mode,
binaryDataMode: binaryDataConfig.mode,
n8n_multi_user_allowed: isUserManagementEnabled(),
smtp_set_up: config.getEnv('userManagement.emails.mode') === 'smtp',
};
2 changes: 1 addition & 1 deletion packages/cli/src/TestWebhooks.ts
Original file line number Diff line number Diff line change
@@ -290,7 +290,7 @@ export class TestWebhooks {
this.testWebhookData[webhookKey].sessionId,
);
} catch (error) {
// Could not inform editor, probably is not connected anymore. So sipmly go on.
// Could not inform editor, probably is not connected anymore. So simply go on.
}
}

Loading

0 comments on commit 49c85a1

Please sign in to comment.