fix: improve grammar and typos in comments (#4922)

GermanAizek · Lukas Holzer · web-flow · commit 2e9d9c06134f · 2023-03-10T14:19:46.000Z
Signed-off-by: Герман Семенов &lt;GermanAizek@yandex.ru&gt;
Co-authored-by: Lukas Holzer &lt;lukas.holzer@netlify.com&gt;
diff --git a/packages/build-info/src/browser/file-system.ts b/packages/build-info/src/browser/file-system.ts
@@ -1,6 +1,6 @@
 import { DirType, FileSystem } from '../file-system.js'
 
-/** A sample implementation of a github provider */
+/** A sample implementation of a GitHub provider */
 export class GithubProvider {
   constructor(public repo: string, public branch?: string) {}
 
@@ -34,7 +34,7 @@ export class GithubProvider {
   }
 }
 
-/** A sample implementation of a web based file system that fetches from Github */
+/** A sample implementation of a web based file system that fetches from GitHub */
 export class WebFS extends FileSystem {
   constructor(public git: GithubProvider) {
     super()
diff --git a/packages/build-info/src/build-systems/build-system.ts b/packages/build-info/src/build-systems/build-system.ts
@@ -24,7 +24,7 @@ export abstract class BaseBuildTool implements BuildSystem {
     }
   }
 
-  /** Get's a JSON from the class information */
+  /** Gets a JSON from the class information */
   toJSON() {
     return { id: this.id, name: this.name, version: this.version }
   }
diff --git a/packages/build-info/src/file-system.ts b/packages/build-info/src/file-system.ts
@@ -50,7 +50,7 @@ export abstract class FileSystem {
   logger: Logger = new DefaultLogger()
 
   /**
-   * This is a in memory representation of the parsed files
+   * This is an in memory representation of the parsed files
    * The keys are always stored in posix style
    * If the value is null then the file did not get read up in memory yet.
    * If the value is a string it already got read up in mem.
@@ -106,7 +106,7 @@ export abstract class FileSystem {
     // the max we have to go up
     const up = Math.max(toUp, fromUp)
 
-    // if we have something from the 'from' to go up go up the max difference
+    // if we have something from the 'from' to go up the max difference
     const result = fromUp > 0 ? [...new Array<string>(up).fill('..')] : []
 
     // if we have some parts left add them to the going up
diff --git a/packages/build-info/src/package-managers/detect-package-manager.ts b/packages/build-info/src/package-managers/detect-package-manager.ts
@@ -16,7 +16,7 @@ export type PkgManagerFields = {
   lockFile: string
   /** Environment variable that can be used to force the usage of a package manager even though there is no lock file or a different lock file */
   forceEnvironment?: string
-  /** Flags that should be used for running the install command */
+  /** Flags that should be used for running the installation command */
   installFlags?: string[]
   /** A list of all cache locations for the package manager */
   cacheLocations?: string[]
@@ -91,7 +91,7 @@ export const detectPackageManager = async (project: Project): Promise<PkgManager
     if (lockFilePath) {
       const lockFile = project.fs.basename(lockFilePath)
       const pkgManager = lockFileMap[lockFile]
-      // check if it not got disabled
+      // check if it is not got disabled
       if (!(pkgManager.forceEnvironment && project.getEnv(pkgManager.forceEnvironment) === 'false')) {
         return pkgManager
       }
diff --git a/packages/build-info/src/project.ts b/packages/build-info/src/project.ts
@@ -27,7 +27,7 @@ export class Project {
     this.baseDirectory = fs.resolve(root || '', baseDirectory !== undefined ? baseDirectory : fs.cwd)
     this.root = root ? fs.resolve(fs.cwd, root) : undefined
 
-    // if the root and the base directory are the same unset the root again as its not a workspace
+    // if the root and the base directory are the same unset the root again as it's not a workspace
     if (this.root === this.baseDirectory) {
       this.root = undefined
     }
diff --git a/packages/build/src/core/config.js b/packages/build/src/core/config.js
@@ -129,7 +129,7 @@ const logConfigInfo = function ({ logs, configPath, buildDir, netlifyConfig, con
 // Retrieve the configuration after it's been changed.
 // This ensures any configuration changes done by plugins is validated and
 // normalized.
-// We use `debug: false` to avoid any debug logs. Otherwise every configuration
+// We use `debug: false` to avoid any debug logs. Otherwise, every configuration
 // change would create debug logs which would be too verbose.
 // Errors are propagated and assigned to the specific plugin or core step
 // which changed the configuration.
@@ -146,7 +146,7 @@ export const resolveUpdatedConfig = async function (configOpts, configMutations)
 // If `netlify.toml` does not exist, create it inside repository root.
 // This is only done when `saveConfig` is `true`. This allows performing this
 // in the buildbot but not in local builds, since only the latter run in a
-// container and we want to avoid saving files on local machines.
+// container, and we want to avoid saving files on local machines.
 export const saveUpdatedConfig = async function ({
   configMutations,
   buildDir,
diff --git a/packages/build/src/core/flags.js b/packages/build/src/core/flags.js
@@ -12,7 +12,7 @@ Defaults to any netlify.toml in the git repository root directory or the base di
   defaultConfig: {
     string: true,
     describe: `JSON configuration object containing default values.
-Each configuration default value is used unless overriden through the main configuration file.
+Each configuration default value is used unless overridden through the main configuration file.
 Default: none.`,
     coerce: jsonParse,
     hidden: true,
diff --git a/packages/build/src/core/lingering.js b/packages/build/src/core/lingering.js
@@ -5,7 +5,7 @@ import { logLingeringProcesses } from '../log/messages/core.js'
 // Print a warning when some build processes are still running.
 // We cannot rely on using the process tree:
 //  - This is because it is impossible to know whether a process was a child of
-//    of another once its parent process has exited. When that happens, the s
+//    another once its parent process has exited. When that happens, the s
 //    child becomes inherited by `init`, changing its `ppid`. The information
 //    about the original parent is then lost.
 //  - The only way to implement this would be to repeatedly list processes as
diff --git a/packages/build/src/core/missing_side_file.js b/packages/build/src/core/missing_side_file.js
@@ -4,7 +4,7 @@ import { pathExists } from 'path-exists'
 
 import { logMissingSideFile } from '../log/messages/core.js'
 
-// Some files like `_headers` and `_redirects` must be copied to the publish
+// Some files like `_headers` and `_redirects` must be copied to the publishing
 // directory to be used in production. When those are present in the repository
 // but not in the publish directory, this most likely indicates that the build
 // command accidentally forgot to copy those. We then print a warning message.
diff --git a/packages/build/src/core/normalize_flags.ts b/packages/build/src/core/normalize_flags.ts
@@ -96,7 +96,7 @@ const getDefaultFlags = function ({ env: envOpt = {} }, combinedEnv) {
   }
 }
 
-// Compute the telemetry flag, it's disabled by default and we want to always disable it
+// Compute the telemetry flag, it's disabled by default, and we want to always disable it
 // if BUILD_TELEMETRY_DISABLED is passed.
 const computeTelemetry = function (flags, envOpts) {
   return envOpts.BUILD_TELEMETRY_DISABLED ? { telemetry: false } : { telemetry: flags.telemetry }
diff --git a/packages/build/src/env/metadata.js b/packages/build/src/env/metadata.js
@@ -2,7 +2,7 @@ import { env } from 'process'
 
 import filterObj from 'filter-obj'
 
-// Retrieve enviroment variables used in error monitoring
+// Retrieve environment variables used in error monitoring
 export const getEnvMetadata = function (childEnv = env) {
   return filterObj(childEnv, isEnvMetadata)
 }
diff --git a/packages/build/src/error/build.js b/packages/build/src/error/build.js
@@ -35,7 +35,7 @@ const assignErrorProp = function (error, name, value) {
 export const errorToJson = function (error) {
   const { name, message, stack, [CUSTOM_ERROR_KEY]: customError, ...errorProps } = error
 
-  // diagnosticText is not enumerable in TSError so we need to grab it manually. destructuring won't work.
+  // diagnosticText is not enumerable in TSError, so we need to grab it manually. destructuring won't work.
   if (error.diagnosticText) {
     errorProps.diagnosticText = error.diagnosticText
   }
diff --git a/packages/build/src/error/handle.ts b/packages/build/src/error/handle.ts
@@ -35,7 +35,7 @@ export const handleBuildError = async function (
 // However, the process (and build) keeps going. Because no files exist anymore,
 // the build eventually crashes with a randomly odd error. Those should not be
 // logged nor reported.
-// However builds canceled with `utils.build.cancelBuild()` should still show
+// However, builds canceled with `utils.build.cancelBuild()` should still show
 // "Build canceled by ..."
 const isCancelCrash = async function (error) {
   const [{ type }] = getErrorInfo(error)
diff --git a/packages/cache-utils/src/hash.ts b/packages/cache-utils/src/hash.ts
@@ -4,11 +4,11 @@ import { createReadStream } from 'fs'
 import getStream from 'get-stream'
 import { locatePath } from 'locate-path'
 
-// We need a hashing algoritm that's as fast as possible.
+// We need a hashing algorithm that's as fast as possible.
 // Userland CRC32 implementations are actually slower than Node.js SHA1.
 const HASH_ALGO = 'sha1'
 
-// Caching a big directory like `node_modules` is slow. However those can
+// Caching a big directory like `node_modules` is slow. However, those can
 // sometime be represented by a digest file such as `package-lock.json`. If this
 // has not changed, we don't need to save cache again.
 export const getHash = async function (digests, move) {
diff --git a/packages/config/src/bin/flags.js b/packages/config/src/bin/flags.js
@@ -32,7 +32,7 @@ Defaults to any netlify.toml in the git repository root directory or the base di
   defaultConfig: {
     string: true,
     describe: `JSON configuration object containing default values.
-Each configuration default value is used unless overriden through the main configuration file.
+Each configuration default value is used unless overridden through the main configuration file.
 Default: none.`,
     coerce: jsonParse,
     hidden: true,
@@ -65,7 +65,7 @@ Default: none.`,
     array: true,
     describe: `Array of changes to apply to the configuration.
 Each change must be an object with three properties:
-  - "keys": array of keys targetting the property to change
+  - "keys": array of keys targeting the property to change
   - "value": new value of that property
   - "event": build event when this change was applied, e.g. "onPreBuild"
 Default: empty array.`,
diff --git a/packages/config/src/build_dir.js b/packages/config/src/build_dir.js
@@ -14,7 +14,7 @@ export const getBuildDir = async function (repositoryRoot, base) {
 }
 
 // The build directory is used as the current directory of build commands and
-// build plugins. Therefore it must exist.
+// build plugins. Therefore, it must exist.
 // We already check `repositoryRoot` earlier in the code, so only need to check
 // `buildDir` when it is the base directory instead.
 const checkBuildDir = async function (buildDir, repositoryRoot) {
diff --git a/packages/config/src/context.js b/packages/config/src/context.js
@@ -82,7 +82,7 @@ const isEdgeFunctionsConfig = function (key, value) {
 }
 
 // Ensure that `inlineConfig` has higher priority than context properties by
-// assigining it to `context.*`. Still keep it at the top-level as well since
+// assigning it to `context.*`. Still keep it at the top-level as well since
 // some properties are not handled context-sensitively by the API.
 // Takes into account that `context.{context}.build.*` is the same as
 // `context.{context}.*`
diff --git a/packages/config/src/default.js b/packages/config/src/default.js
@@ -1,7 +1,7 @@
 import { addBuildSettings } from './api/build_settings.js'
 import { logDefaultConfig } from './log/main.js'
 
-// Retrieve default configuration file. It has less priority and it also does
+// Retrieve default configuration file. It has less priority, and it also does
 // not get normalized, merged with contexts, etc.
 export const parseDefaultConfig = function ({ defaultConfig, base, baseRelDir, siteInfo, logs, debug }) {
   const defaultConfigB = addDefaultConfigBase(defaultConfig, base)
@@ -25,7 +25,7 @@ const addDefaultConfigBase = function (defaultConfig, base) {
   return { ...defaultConfig, build: { ...build, base } }
 }
 
-// `baseRelDir` should default to `true` only if the option was not passed and
+// `baseRelDir` should default to `true` only if the option was not passed, and
 // it could be retrieved from the `siteInfo`, which is why the default value
 // is assigned later than other properties.
 const DEFAULT_BASE_REL_DIR = true
diff --git a/packages/config/src/files.js b/packages/config/src/files.js
@@ -16,7 +16,7 @@ export const resolveConfigPaths = function ({ config, repositoryRoot, buildDir,
   return configB
 }
 
-// All file paths in the configuration file are are relative to `buildDir`
+// All file paths in the configuration file are relative to `buildDir`
 // (if `baseRelDir` is `true`).
 const FILE_PATH_CONFIG_PROPS = [
   'functionsDirectory',
@@ -56,7 +56,7 @@ export const resolvePath = function (repositoryRoot, baseRel, originalPath, prop
 const LEADING_SLASH_REGEXP = /^\/+/
 
 // We ensure all file paths are within the repository root directory.
-// However we allow file paths to be outside of the build directory, since this
+// However, we allow file paths to be outside the build directory, since this
 // can be convenient in monorepo setups.
 const validateInsideRoot = function (originalPath, path, repositoryRoot, propName) {
   if (relative(repositoryRoot, path).startsWith('..') || getWindowsDrive(repositoryRoot) !== getWindowsDrive(path)) {
diff --git a/packages/config/src/log/logger.js b/packages/config/src/log/logger.js
@@ -29,7 +29,7 @@ export const log = function (logs, string, { color } = {}) {
   console.warn(stringB)
 }
 
-// We need to add a zero width space character in empty lines. Otherwise the
+// We need to add a zero width space character in empty lines. Otherwise, the
 // buildbot removes those due to a bug: https://github.com/netlify/buildbot/issues/595
 const EMPTY_LINES_REGEXP = /^\s*$/gm
 const EMPTY_LINE = '\u{200B}'
diff --git a/packages/config/src/merge.js b/packages/config/src/merge.js
@@ -17,7 +17,7 @@ const removeUndefinedProps = function ({ build = {}, ...config }) {
   return removeUndefined({ ...config, build: removeUndefined(build) })
 }
 
-// By default `deepmerge` concatenates arrays. We use the `arrayMerge` option
+// By default, `deepmerge` concatenates arrays. We use the `arrayMerge` option
 // to remove this behavior. Also, we merge some array properties differently,
 // such as `plugins`.
 const arrayMerge = function (arrayA, arrayB) {
diff --git a/packages/config/src/mutations/update.js b/packages/config/src/mutations/update.js
@@ -69,7 +69,7 @@ const deleteSideFile = async function (filePath) {
 }
 
 // Modifications to `netlify.toml` and `_headers/_redirects` are only meant for
-// the deploy API call. After it's been performed, we restore their former
+// the deployment API call. After it's been performed, we restore their former
 // state.
 // We do this by backing them up inside some sibling directory.
 const backupConfig = async function ({ buildDir, configPath, headersPath, redirectsPath }) {
diff --git a/packages/config/src/normalize.js b/packages/config/src/normalize.js
@@ -14,7 +14,7 @@ export const normalizeConfig = function (config) {
 
 // Remove empty strings.
 // This notably ensures that empty strings in the build command are removed.
-// Otherwise those would be run during builds, making the build fail.
+// Otherwise, those would be run during builds, making the build fail.
 const removeEmpty = function ({ build, ...config }) {
   return removeFalsy({ ...config, build: removeFalsy(build) })
 }
diff --git a/packages/config/src/options/base.js b/packages/config/src/options/base.js
@@ -23,7 +23,7 @@ export const getBaseOverride = async function ({ repositoryRoot, cwd }) {
   // `base` starting with a `/` are relative to `repositoryRoot`, so we cannot
   // return an absolute path
   const base = relative(repositoryRoot, dirname(basePath))
-  // When `base` is explicitely overridden, `baseRelDir: true` makes more sense
+  // When `base` is explicitly overridden, `baseRelDir: true` makes more sense
   // since we want `publish`, `functions` and `edge_functions` to be relative to it.
   return { base, baseRelDir: true }
 }
diff --git a/packages/config/src/utils/toml.js b/packages/config/src/utils/toml.js
@@ -4,7 +4,7 @@ import tomlify from 'tomlify-j0.4'
 // Parse from TOML to JavaScript
 export const parseToml = function (configString) {
   const config = loadToml(configString)
-  // `toml.parse()` returns a object with `null` prototype deeply, which can
+  // `toml.parse()` returns an object with `null` prototype deeply, which can
   // sometimes create problems with some utilities. We convert it.
   // TOML can return Date instances, but JSON will stringify those, and we
   // don't use Date in netlify.toml, so this should be ok.
diff --git a/packages/functions-utils/src/main.ts b/packages/functions-utils/src/main.ts
@@ -5,7 +5,7 @@ import { listFunctions, listFunctionsFiles } from '@netlify/zip-it-and-ship-it'
 import cpy from 'cpy'
 import { pathExists } from 'path-exists'
 
-// Add a Netlify Function file to the `functions` directory so it is processed
+// Add a Netlify Function file to the `functions` directory, so it is processed
 // by `@netlify/plugin-functions-core`
 export const add = async function (src?: string, dist?: string, { fail = defaultFail } = {}): Promise<void> {
   if (src === undefined) {
diff --git a/packages/git-utils/src/exec.ts b/packages/git-utils/src/exec.ts
@@ -11,7 +11,7 @@ const mGit = function (args, cwd) {
     const { stdout } = execaSync('git', args, { cwd: cwdA })
     return stdout
   } catch (error) {
-    // The child process `error.message` includes stderr and stdout output which most of the times contains duplicate
+    // The child process `error.message` includes stderr and stdout output which most of the time contains duplicate
     // information. We rely on `error.shortMessage` instead.
     error.message = error.shortMessage
     throw error
diff --git a/packages/headers-parser/src/merge.ts b/packages/headers-parser/src/merge.ts
@@ -48,7 +48,7 @@ const removeDuplicates = function (headers: Header[]) {
   return result.reverse()
 }
 
-// We generate a unique header key based on JSON stringify. However because some
+// We generate a unique header key based on JSON stringify. However, because some
 // properties can be regexes, we need to replace those by their toString representation
 // given the default will be and empty object
 const generateHeaderKey = function (header: Header) {
diff --git a/packages/headers-parser/src/netlify_config_parser.ts b/packages/headers-parser/src/netlify_config_parser.ts
@@ -6,7 +6,7 @@ import { parse as loadToml } from 'toml'
 import { splitResults } from './results.js'
 
 // Parse `headers` field in "netlify.toml" to an array of objects.
-// This field is already an array of objects so it only validates and
+// This field is already an array of objects, so it only validates and
 // normalizes it.
 export const parseConfigHeaders = async function (netlifyConfigPath: string) {
   if (!(await pathExists(netlifyConfigPath))) {
diff --git a/packages/headers-parser/src/normalize.ts b/packages/headers-parser/src/normalize.ts
@@ -8,7 +8,7 @@ import type { Header } from './types.js'
 
 // Validate and normalize an array of `headers` objects.
 // This step is performed after `headers` have been parsed from either
-// `netlify.toml` or `_headerss`.
+// `netlify.toml` or `_headers`.
 export const normalizeHeaders = function (headers: any, minimal: boolean) {
   if (!Array.isArray(headers)) {
     const error = new TypeError(`Headers must be an array not: ${headers}`)
diff --git a/packages/headers-parser/src/results.ts b/packages/headers-parser/src/results.ts
@@ -11,7 +11,7 @@ const isError = function (result: any): result is Error {
   return result instanceof Error
 }
 
-// Concatenate an array of `{ headers, erors }`
+// Concatenate an array of `{ headers, errors }`
 export const concatResults = function (resultsArrays: { headers: Header[]; errors: Error[] }[]) {
   const headers = resultsArrays.flatMap(({ headers }) => headers)
   const errors = resultsArrays.flatMap(({ errors }) => errors)
diff --git a/packages/redirect-parser/src/all.ts b/packages/redirect-parser/src/all.ts
@@ -4,8 +4,8 @@ import { parseConfigRedirects } from './netlify_config_parser.js'
 import { normalizeRedirects } from './normalize.js'
 import { splitResults, concatResults } from './results.js'
 
-// Parse all redirects given programmatically via the `configRedirects` property, `netlify.toml` and `_redirects` files, then normalize
-// and validate those.
+// Parse all redirects given programmatically via the `configRedirects` property, `netlify.toml` and `_redirects`
+// files, then normalize and validate those.
 export const parseAllRedirects = async function ({
   redirectsFiles = [],
   netlifyConfigPath,
diff --git a/packages/redirect-parser/src/netlify_config_parser.js b/packages/redirect-parser/src/netlify_config_parser.js
@@ -6,7 +6,7 @@ import { parse as loadToml } from 'toml'
 import { splitResults } from './results.js'
 
 // Parse `redirects` field in "netlify.toml" to an array of objects.
-// This field is already an array of objects so it only validates and
+// This field is already an array of objects, so it only validates and
 // normalizes it.
 export const parseConfigRedirects = async function (netlifyConfigPath) {
   if (!(await pathExists(netlifyConfigPath))) {
diff --git a/packages/redirect-parser/src/results.js b/packages/redirect-parser/src/results.js
@@ -9,7 +9,7 @@ const isError = function (result) {
   return result instanceof Error
 }
 
-// Concatenate an array of `{ redirects, erors }`
+// Concatenate an array of `{ redirects, errors }`
 export const concatResults = function (resultsArrays) {
   const redirects = resultsArrays.flatMap(getRedirects)
   const errors = resultsArrays.flatMap(getErrors)

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import { DirType, FileSystem } from '../file-system.js'`
`2`	`2`
`3`		`-/** A sample implementation of a github provider */`
	`3`	`+/** A sample implementation of a GitHub provider */`
`4`	`4`	`export class GithubProvider {`
`5`	`5`	`constructor(public repo: string, public branch?: string) {}`
`6`	`6`
`@@ -34,7 +34,7 @@ export class GithubProvider {`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`
`37`		`-/** A sample implementation of a web based file system that fetches from Github */`
	`37`	`+/** A sample implementation of a web based file system that fetches from GitHub */`
`38`	`38`	`export class WebFS extends FileSystem {`
`39`	`39`	`constructor(public git: GithubProvider) {`
`40`	`40`	`super()`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ export abstract class BaseBuildTool implements BuildSystem {`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`
`27`		`- /** Get's a JSON from the class information */`
	`27`	`+ /** Gets a JSON from the class information */`
`28`	`28`	`toJSON() {`
`29`	`29`	`return { id: this.id, name: this.name, version: this.version }`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ export class Project {`
`27`	`27`	`this.baseDirectory = fs.resolve(root \|\| '', baseDirectory !== undefined ? baseDirectory : fs.cwd)`
`28`	`28`	`this.root = root ? fs.resolve(fs.cwd, root) : undefined`
`29`	`29`
`30`		`- // if the root and the base directory are the same unset the root again as its not a workspace`
	`30`	`+ // if the root and the base directory are the same unset the root again as it's not a workspace`
`31`	`31`	`if (this.root === this.baseDirectory) {`
`32`	`32`	`this.root = undefined`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ const getDefaultFlags = function ({ env: envOpt = {} }, combinedEnv) {`
`96`	`96`	`}`
`97`	`97`	`}`
`98`	`98`
`99`		`-// Compute the telemetry flag, it's disabled by default and we want to always disable it`
	`99`	`+// Compute the telemetry flag, it's disabled by default, and we want to always disable it`
`100`	`100`	`// if BUILD_TELEMETRY_DISABLED is passed.`
`101`	`101`	`const computeTelemetry = function (flags, envOpts) {`
`102`	`102`	`return envOpts.BUILD_TELEMETRY_DISABLED ? { telemetry: false } : { telemetry: flags.telemetry }`