From ad054c855dec8358fe7d95bc115c2b2933ff73f3 Mon Sep 17 00:00:00 2001 From: Josh Soref Date: Wed, 21 Aug 2019 15:31:44 -0400 Subject: [PATCH] Spelling (#72) * spelling: check in * spelling: compatibility * spelling: definitely * spelling: does not * spelling: maintaining * spelling: nonexistent * spelling: precede * spelling: response * spelling: was not --- docs/action-versioning.md | 4 ++-- docs/javascript-action.md | 2 +- packages/core/README.md | 2 +- packages/core/__tests__/lib.test.ts | 6 +++--- packages/core/src/command.ts | 2 +- packages/exec/src/toolrunner.ts | 2 +- packages/io/__tests__/io.test.ts | 6 +++--- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/action-versioning.md b/docs/action-versioning.md index 88ca2a89..a8f7e7e8 100644 --- a/docs/action-versioning.md +++ b/docs/action-versioning.md @@ -13,9 +13,9 @@ steps: Binding to the immutable sha1 of a released version is the safest for stability and security. -Binding to a specific major version allows for receiving critical fixes and security patches while still mainting compatibility and the assurance your workflow should still work. +Binding to a specific major version allows for receiving critical fixes and security patches while still maintaining compatibility and the assurance your workflow should still work. -Binding to master is convenient but if a new major version is released which breaks compatilibility, your workflow could break. +Binding to master is convenient but if a new major version is released which breaks compatibility, your workflow could break. # Recommendations diff --git a/docs/javascript-action.md b/docs/javascript-action.md index 75a6a615..c83c6182 100644 --- a/docs/javascript-action.md +++ b/docs/javascript-action.md @@ -117,7 +117,7 @@ $ git checkout -b v1-release > NOTE: We will provide tooling and an action to automate this soon. -Checkin production dependencies: +Check in production dependencies: 1. **Do not ignore node_modules**: Add a `!` in front of the `node_modules` line. 2. **Delete node_modules**: rm -Rf node_modules 3. **Install production dependencies**: npm install --production diff --git a/packages/core/README.md b/packages/core/README.md index ade0b6f3..2ad866ac 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -70,7 +70,7 @@ try { core.debug('Inside try block'); if (!myInput) { - core.warning('myInput wasnt set'); + core.warning('myInput was not set'); } // Do stuff diff --git a/packages/core/__tests__/lib.test.ts b/packages/core/__tests__/lib.test.ts index 43ee4a83..48ea14b4 100644 --- a/packages/core/__tests__/lib.test.ts +++ b/packages/core/__tests__/lib.test.ts @@ -16,7 +16,7 @@ const testEnvVars = { // Set inputs INPUT_MY_INPUT: 'val', INPUT_MISSING: '', - 'INPUT_SPECIAL_CHARS_\'\t"\\': '\'\t"\\ repsonse ' + 'INPUT_SPECIAL_CHARS_\'\t"\\': '\'\t"\\ response ' } describe('@actions/core', () => { @@ -101,7 +101,7 @@ describe('@actions/core', () => { ) }) - it('getInput doesnt throw on missing non-required input', () => { + it('getInput does not throw on missing non-required input', () => { expect(core.getInput('missing', {required: false})).toBe('') }) @@ -110,7 +110,7 @@ describe('@actions/core', () => { }) it('getInput handles special characters', () => { - expect(core.getInput('special chars_\'\t"\\')).toBe('\'\t"\\ repsonse') + expect(core.getInput('special chars_\'\t"\\')).toBe('\'\t"\\ response') }) it('setOutput produces the correct command', () => { diff --git a/packages/core/src/command.ts b/packages/core/src/command.ts index 73c27aed..c3cb7058 100644 --- a/packages/core/src/command.ts +++ b/packages/core/src/command.ts @@ -14,7 +14,7 @@ interface CommandProperties { * * Examples: * ##[warning]This is the user warning message - * ##[set-secret name=mypassword]definatelyNotAPassword! + * ##[set-secret name=mypassword]definitelyNotAPassword! */ export function issueCommand( command: string, diff --git a/packages/exec/src/toolrunner.ts b/packages/exec/src/toolrunner.ts index 206015b3..32dc5f94 100644 --- a/packages/exec/src/toolrunner.ts +++ b/packages/exec/src/toolrunner.ts @@ -216,7 +216,7 @@ export class ToolRunner extends events.EventEmitter { // command line from libuv quoting rules would look like: // foo.exe "myarg:\"my val\"" // - // 3) double-up slashes that preceed a quote, + // 3) double-up slashes that precede a quote, // e.g. hello \world => "hello \world" // hello\"world => "hello\\""world" // hello\\"world => "hello\\\\""world" diff --git a/packages/io/__tests__/io.test.ts b/packages/io/__tests__/io.test.ts index 1c6aea87..3fd12ea7 100644 --- a/packages/io/__tests__/io.test.ts +++ b/packages/io/__tests__/io.test.ts @@ -88,7 +88,7 @@ describe('cp', () => { }) it('copies directory into non-existing destination with -r', async () => { - const root: string = path.join(getTestTemp(), 'cp_with_-r_nonexisting_dest') + const root: string = path.join(getTestTemp(), 'cp_with_-r_nonexistent_dest') const sourceFolder: string = path.join(root, 'cp_source') const sourceFile: string = path.join(sourceFolder, 'cp_source_file') @@ -245,7 +245,7 @@ describe('mv', () => { it('moves directory into non-existing destination', async () => { const root: string = path.join( getTestTemp(), - ' mv_with_-r_nonexisting_dest' + ' mv_with_-r_nonexistent_dest' ) const sourceFolder: string = path.join(root, ' mv_source') const sourceFile: string = path.join(sourceFolder, ' mv_source_file') @@ -321,7 +321,7 @@ describe('rmRF', () => { await assertNotExists(testPath) }) - it('removes folder that doesnt exist with rmRF', async () => { + it('removes folder that does not exist with rmRF', async () => { const testPath = path.join(getTestTemp(), 'testFolder') await assertNotExists(testPath)