refactor: use Americian English

Author: alvis

CODE_OF_CONDUCT.md

@@ -14,7 +14,7 @@ diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behaviour that contributes to a positive environment for our
+Examples of behavior that contributes to a positive environment for our
 community include:
 
 - Demonstrating empathy and kindness toward other people
@@ -25,9 +25,9 @@ community include:
 - Focusing on what is best not just for us as individuals, but for the
   overall community
 
-Examples of unacceptable behaviour include:
+Examples of unacceptable behavior include:
 
-- The use of sexualied language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
 - Trolling, insulting or derogatory comments, and personal or political attacks
 - Public or private harassment
@@ -39,8 +39,8 @@ Examples of unacceptable behaviour include:
 ## Enforcement Responsibilities
 
 Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behaviour and will take appropriate and fair corrective action in
-response to any behaviour that they deem inappropriate, threatening, offensive,
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
 or harmful.
 
 Community leaders have the right and responsibility to remove, edit, or reject
@@ -58,7 +58,7 @@ representative at an online or offline event.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at alvis@hilbert.space.
 All complaints will be reviewed and investigated promptly and fairly.
 
@@ -72,19 +72,19 @@ the consequences for any action they deem in violation of this Code of Conduct:
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behaviour deemed
+**Community Impact**: Use of inappropriate language or other behavior deemed
 unprofessional or unwelcome in the community.
 
 **Consequence**: A private, written warning from community leaders, providing
 clarity around the nature of the violation and an explanation of why the
-behaviour was inappropriate. A public apology may be requested.
+behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
 **Community Impact**: A violation through a single incident or series
 of actions.
 
-**Consequence**: A warning with consequences for continued behaviour. No
+**Consequence**: A warning with consequences for continued behavior. No
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
 includes avoiding interactions in community spaces as well as external channels
@@ -94,7 +94,7 @@ permanent ban.
 ### 3. Temporary Ban
 
 **Community Impact**: A serious violation of community standards, including
-sustained inappropriate behaviour.
+sustained inappropriate behavior.
 
 **Consequence**: A temporary ban from any sort of interaction or public
 communication with the community for a specified period of time. No public or
@@ -105,7 +105,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behaviour, harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

source/client.ts

@@ -147,7 +147,7 @@ export class Notion {
       ...body,
       title: body.title.map((text) => text.plain_text).join(''),
       pages: await Promise.all(
-        pages.map(this.normalisePageAndCache.bind(this)),
+        pages.map(this.normalizePageAndCache.bind(this)),
       ),
     };
   }
@@ -167,7 +167,7 @@ export class Notion {
       { ttl: this.ttl.pageMeta },
     );
 
-    return this.normalisePageAndCache(body);
+    return this.normalizePageAndCache(body);
   }
 
   /**
@@ -241,7 +241,7 @@ export class Notion {
    * @param page the page object returned from Notion API
    * @returns page with title and its content
    */
-  private async normalisePage(page: Page): Promise<FullPage> {
+  private async normalizePage(page: Page): Promise<FullPage> {
     // NOTE: API calls will be made for getting blocks as no cache will be set
     const blocks = await this.getBlocks(page.id);
     // Name for a page in a database, title for an ordinary page
@@ -274,11 +274,11 @@ export class Notion {
   }
 
   /**
-   * normalised a page, or get it from the cache
+   * normalized a page, or get it from the cache
    * @param page the page object returned from Notion API
    * @returns page with title and its content
    */
-  private async normalisePageAndCache(page: Page): Promise<FullPage> {
+  private async normalizePageAndCache(page: Page): Promise<FullPage> {
     const cacheKey = `page:${page.id}:content`;
     const cachedPage = await this.cache.get<FullPage>(cacheKey);
 
@@ -290,16 +290,16 @@ export class Notion {
     ) {
       return cachedPage;
     } else {
-      const normalisedPage = await this.normalisePage(page);
+      const normalizedPage = await this.normalizePage(page);
       await this.cache.set(
         cacheKey,
-        normalisedPage,
+        normalizedPage,
         // NOTE: by default the cache would last forever and
         //       therefore no API call will be make unless the last_edit_time has changed
         { ttl: this.ttl.pageContent },
       );
 
-      return normalisedPage;
+      return normalizedPage;
     }
   }
 }

source/gatsby-node.ts

@@ -16,7 +16,7 @@
 import { version as gatsbyVersion } from 'gatsby/package.json';
 
 import { name } from '#.';
-import { computePreviewUpdateInterval, normaliseConfig, sync } from '#plugin';
+import { computePreviewUpdateInterval, normalizeConfig, sync } from '#plugin';
 
 import type { GatsbyNode } from 'gatsby';
 
@@ -56,32 +56,33 @@ export const onPreBootstrap: NonNullable<GatsbyNode['onPreBootstrap']> = async (
   }
 };
 
-export const onCreateDevServer: NonNullable<GatsbyNode['onCreateDevServer']> =
-  async (args, partialConfig) => {
-    const pluginConfig = normaliseConfig(partialConfig);
-    const { previewCallRate } = pluginConfig;
+export const onCreateDevServer: NonNullable<
+  GatsbyNode['onCreateDevServer']
+> = async (args, partialConfig) => {
+  const pluginConfig = normalizeConfig(partialConfig);
+  const { previewCallRate } = pluginConfig;
 
-    const previewUpdateInterval = computePreviewUpdateInterval(pluginConfig);
-    if (previewCallRate && previewUpdateInterval) {
-      const scheduleUpdate = (): NodeJS.Timeout =>
-        setTimeout(async () => {
-          // sync entities from notion
-          await sync(args, pluginConfig);
+  const previewUpdateInterval = computePreviewUpdateInterval(pluginConfig);
+  if (previewCallRate && previewUpdateInterval) {
+    const scheduleUpdate = (): NodeJS.Timeout =>
+      setTimeout(async () => {
+        // sync entities from notion
+        await sync(args, pluginConfig);
 
-          // schedule the next update
-          scheduleUpdate();
-        }, previewUpdateInterval);
+        // schedule the next update
+        scheduleUpdate();
+      }, previewUpdateInterval);
 
-      scheduleUpdate();
-    }
-  };
+    scheduleUpdate();
+  }
+};
 
 export const sourceNodes: NonNullable<GatsbyNode['sourceNodes']> = async (
   args,
   partialConfig,
 ) => {
   // sync entities from notion
-  await sync(args, normaliseConfig(partialConfig));
+  await sync(args, normalizeConfig(partialConfig));
 };
 
 /* eslint-enable */

source/node.ts

@@ -34,7 +34,7 @@ interface Link {
 }
 
 type FullEntity = FullDatabase | FullPage;
-type NormalisedEntity<E extends FullEntity = FullEntity> = E extends any
+type NormalizedEntity<E extends FullEntity = FullEntity> = E extends any
   ? Omit<E, 'parent'> & {
       parent: Link | null;
       children: Link[];
@@ -207,7 +207,7 @@ export class NodeManager {
    * @returns a database node
    */
   private createDatabaseNode(
-    database: NormalisedEntity<FullDatabase>,
+    database: NormalizedEntity<FullDatabase>,
   ): ContentNode<'NotionDatabase'> {
     return this.createBaseNode(database, { type: 'NotionDatabase' });
   }
@@ -218,7 +218,7 @@ export class NodeManager {
    * @returns a page node
    */
   private createPageNode(
-    page: NormalisedEntity<FullPage>,
+    page: NormalizedEntity<FullPage>,
   ): ContentNode<'NotionPage'> {
     return this.createBaseNode(page, {
       type: 'NotionPage',
@@ -234,7 +234,7 @@ export class NodeManager {
    * @returns a node with common data
    */
   private createBaseNode<T extends string>(
-    entity: NormalisedEntity,
+    entity: NormalizedEntity,
     internal: Omit<NodeInput['internal'], 'contentDigest'> & { type: T },
   ): ContentNode<T> {
     const basis = {
@@ -269,7 +269,7 @@ export class NodeManager {
    * @param entity the entity to be converted
    * @returns converted entity ready to be consumed by gatsby
    */
-  private nodifyEntity(entity: NormalisedEntity): NodeInput {
+  private nodifyEntity(entity: NormalizedEntity): NodeInput {
     switch (entity.object) {
       case 'database':
         return this.createDatabaseNode(entity);
@@ -320,13 +320,13 @@ export function computeChanges(
  */
 export function computeEntityMap(
   entities: FullEntity[],
-): Map<string, NormalisedEntity> {
+): Map<string, NormalizedEntity> {
   // create a new working set
-  const map = new Map<string, NormalisedEntity>();
+  const map = new Map<string, NormalizedEntity>();
   for (const entity of entities) {
     map.set(`${entity.object}:${entity.id}`, {
       ...entity,
-      parent: normaliseParent(entity.parent),
+      parent: normalizeParent(entity.parent),
       children: [],
     });
   }
@@ -357,7 +357,7 @@ export function computeEntityMap(
  * @param parent the parent field returned from Notion API
  * @returns information about the parent in an unified format
  */
-export function normaliseParent(parent: FullEntity['parent']): Link | null {
+export function normalizeParent(parent: FullEntity['parent']): Link | null {
   switch (parent.type) {
     case 'database_id':
       return { object: 'database', id: parent.database_id };

source/plugin.ts

@@ -46,7 +46,7 @@ const DEFAULT_PREVIEW_API_RATE = 2.5;
 
 /**
  * compute the update interval for the preview mode
- * @param pluginConfig the normalised plugin config
+ * @param pluginConfig the normalized plugin config
  * @returns the number of milliseconds needed between each sync
  */
 export function computePreviewUpdateInterval(
@@ -75,7 +75,7 @@ export function computePreviewUpdateInterval(
  * @param config pluginConfig passed from the plugin options
  * @returns a complete config
  */
-export function normaliseConfig(
+export function normalizeConfig(
   config: Partial<PluginConfig>,
 ): FullPluginConfig {
   const { previewCallRate = DEFAULT_PREVIEW_API_RATE } = config;
@@ -148,7 +148,7 @@ export async function getPages(
 }
 
 /**
- * synchronise data between Notion and Gatsby
+ * synchronize data between Notion and Gatsby
  * @param args argument passed from Gatsby's Node API
  * @param pluginConfig pluginConfig passed from the plugin options
  */

source/property.ts

@@ -19,23 +19,23 @@ type Date = { start: string; end?: string };
 
 type Person = { name: string; avatar?: string };
 
-type NormalisedValue =
+type NormalizedValue =
   | undefined
   | boolean
   | number
   | string
   | string[]
   | Date
   | Person
-  | NormalisedValue[];
+  | NormalizedValue[];
 
 /* eslint-disable max-lines-per-function */
 /**
  * extract the content from a property
  * @param property a property returned from Notion API
  * @returns its content
  */
-export function getPropertyContent(property: PropertyValue): NormalisedValue {
+export function getPropertyContent(property: PropertyValue): NormalizedValue {
   switch (property.type) {
     case 'title':
       return property.title.map((text) => text.plain_text).join('');
@@ -89,7 +89,7 @@ export function getPropertyContent(property: PropertyValue): NormalisedValue {
  */
 function getFormulaPropertyContent(
   formula: FormulaValue['formula'],
-): NormalisedValue {
+): NormalizedValue {
   switch (formula.type) {
     case 'string':
       return formula.string;
@@ -112,7 +112,7 @@ function getFormulaPropertyContent(
  */
 function getRollupPropertyContent(
   rollup: RollupValue['rollup'],
-): NormalisedValue | NormalisedValue[] {
+): NormalizedValue | NormalizedValue[] {
   switch (rollup.type) {
     case 'number':
       return rollup.number;

source/types/format.ts

@@ -17,7 +17,7 @@ import type { DateValue } from './property';
 import type { User } from './user';
 
 /*
- * Colour
+ * Color
  */
 
 export type Color =

spec/example.ts

@@ -127,9 +127,9 @@ export const richtext: RichText[] = [
       underline: false,
     },
     href: null,
-    plain_text: 'colour',
+    plain_text: 'color',
     text: {
-      content: 'colour',
+      content: 'color',
       link: null,
     },
     type: 'text',
@@ -1201,7 +1201,7 @@ export const full: FullBlock[] = [
         },
         {
           type: 'text',
-          text: { content: 'colour', link: null },
+          text: { content: 'color', link: null },
           annotations: {
             bold: false,
             italic: false,
@@ -1210,7 +1210,7 @@ export const full: FullBlock[] = [
             code: false,
             color: 'yellow_background',
           },
-          plain_text: 'colour',
+          plain_text: 'color',
           href: null,
         },
       ],

spec/markdown.spec.ts

@@ -314,7 +314,7 @@ Toggled Content
 
 @Alvis Tang [gatsby-source-notion](https://www.notion.so/8468103a77ae4b1a8fcda89951c9c007) [Link](https://link)
 
-# _**Annotated**_ ~~_**Heading**_~~ with $x^2$ and colour
+# _**Annotated**_ ~~_**Heading**_~~ with $x^2$ and color
 
 # Unsupported