consistency within comments

Author: neverRare

CONTRIBUTING.md

@@ -58,7 +58,7 @@ More things to remember:
 - Keep the source code as runtime agnostic as possible. We target the browser
   and Deno. This is necessary because we use `deno test`. If a module is
   exclusive to one runtime, add a note above the code:
-  `// This code is browser/Deno only`.
+  `// this code is browser/Deno only`.
 
 (The following aren't strict rules. It's perfectly fine to not follow any of
 these for any reason e.g. you just want to fix typo.)

build/build.ts

@@ -1,4 +1,4 @@
-// This code is Deno only
+// this code is Deno only
 
 import * as ESBuild from "esbuild";
 import * as Dictionary from "../dictionary/build.ts";

build/config.ts

@@ -1,4 +1,4 @@
-// This code is Deno only
+// this code is Deno only
 
 import { denoPlugins } from "@luca/esbuild-deno-loader";
 import { BuildOptions } from "esbuild";

build/dev.ts

@@ -1,4 +1,4 @@
-// This code is Deno only
+// this code is Deno only
 
 import { assert } from "@std/assert/assert";
 import { exists } from "@std/fs/exists";

dictionary/build.ts

@@ -1,4 +1,4 @@
-// This code is Deno only
+// this code is Deno only
 
 // deno-lint-ignore-file no-console
 
@@ -19,7 +19,7 @@ export async function buildWithDictionary(
     2,
   );
   const code = `\
-// This code is autogenerated
+// this code is autogenerated
 
 import { Dictionary } from "./type.ts";
 
@@ -68,7 +68,7 @@ function displayError(source: string, errors: ReadonlyArray<ArrayResultError>) {
     if (error instanceof PositionedError && error.position != null) {
       const { position, length } = error.position;
       const end = position + length;
-      // The only instance returning -1 is useful
+      // the only instance returning -1 is useful
       const startLine = source.lastIndexOf("\n", position) + 1;
       let currentLine = startLine;
       let currentPosition = position;

dictionary/test.ts

@@ -1,4 +1,4 @@
-// This code is Deno only
+// this code is Deno only
 
 import { assertMatch } from "@std/assert/match";
 import { dictionary } from "./dictionary.ts";

dictionary/watch.ts

@@ -1,4 +1,4 @@
-// This code is Deno only
+// this code is Deno only
 
 import { unreachable } from "@std/assert/unreachable";
 import { debounce } from "@std/async/debounce";

misc/misc.ts

@@ -1,4 +1,4 @@
-// Ensure this module don't have imports and as runtime agnostic as possible,
+// ensure this module don't have imports and as runtime agnostic as possible,
 // make separate module when necessary
 
 export function nullableAsArray<T>(value?: T): ReadonlyArray<NonNullable<T>> {

src/array_result.ts

@@ -98,7 +98,7 @@ export class ArrayResult<T> {
       & Readonly<{ [I in keyof T]: ArrayResult<T[I]> }>
       & Readonly<{ length: T["length"] }>
   ): ArrayResult<T> {
-    // We resorted to using `any` types here, make sure it works properly
+    // we resorted to using `any` types here, make sure it works properly
     return arrayResults.reduce(
       (left: ArrayResult<any>, right) => {
         if (left.isError() && right.isError()) {

src/dictionary.ts

@@ -2,7 +2,7 @@ import { dictionary as globalDictionary } from "../dictionary/dictionary.ts";
 import { Definition, Dictionary } from "../dictionary/type.ts";
 import { load } from "../telo_misikeke/telo_misikeke.js";
 
-// All of these global constants are mutable
+// all of these global constants are mutable
 
 const customDictionary: Dictionary = new Map();
 export const dictionary: Dictionary = new Map();

src/examples.ts

@@ -1,4 +1,4 @@
-// Examples gathered from https://github.com/kilipan/nasin-toki
+// examples gathered from https://github.com/kilipan/nasin-toki
 // CC-BY-SA 4.0 https://github.com/kilipan/nasin-toki/blob/main/LICENSE.txt
 export const EXAMPLE_SENTENCES = [
   "anu seme",
@@ -189,7 +189,7 @@ export const EXAMPLE_SENTENCES = [
   "mi alasa sitelen e lipu pona",
   "jan sona li alasa sona e ijo mute",
 ];
-// Examples taken from https://telo-misikeke.gitlab.io/
+// examples taken from https://telo-misikeke.gitlab.io/
 export const MALFORMED_SENTENCES = [
   "mi jan Nikola, li kama pana e lukin pi ilo ni tawa sini.",
   "mi pona, taso, toki mi li ken pi ike.",

src/main.ts

@@ -1,6 +1,6 @@
-// This code is browser only
+// this code is browser only
 
-// This is defined by esbuild
+// this is defined by esbuild
 declare const LIVE_RELOAD: boolean;
 
 // auto-refresh when source code have changed

src/parser/filter.ts

@@ -22,7 +22,7 @@ import {
 import { UnrecognizedError } from "./parser_lib.ts";
 
 export const WORD_UNIT_RULES: ReadonlyArray<(wordUnit: WordUnit) => boolean> = [
-  // avoid "seme ala seme"
+  // disallow "seme ala seme"
   (wordUnit) =>
     wordUnit.type !== "x ala x" || wordUnit.word !== "seme" ||
     throwError(new UnrecognizedError('"seme ala seme"')),
@@ -100,29 +100,29 @@ export const MODIFIER_RULES: ReadonlyArray<(modifier: Modifier) => boolean> = [
 export const MULTIPLE_MODIFIERS_RULES: ReadonlyArray<
   (modifier: ReadonlyArray<Modifier>) => boolean
 > = [
-  // // no multiple pi
+  // // disallow multiple pi
   // (modifiers) =>
   //   modifiers.filter(({type}) => type === "pi").length <= 1 ||
   //   throwError(new UnrecognizedError("multiple pi")),
 
-  // no multiple nanpa
+  // disallow multiple nanpa
   (modifiers) =>
     modifiers.filter(({ type }) => type === "nanpa").length <= 1 ||
     throwError(new UnrecognizedError("multiple nanpa")),
 
-  // no multiple proper words
+  // disallow multiple proper words
   (modifiers) =>
     modifiers
         .filter(({ type }) => type === "proper words")
         .length <= 1 ||
     throwError(new UnrecognizedError("multiple proper words")),
 
-  // no multiple number words
+  // disallow multiple number words
   (modifiers) =>
     modifiers.filter(modifierIsNumeric).length <= 1 ||
     throwError(new UnrecognizedError("multiple number words")),
 
-  // avoid duplicate modifiers when disabled by settings
+  // disallow duplicate modifiers when disabled by settings
   (modifiers) => {
     if (settings.separateRepeatedModifiers) {
       return true;
@@ -167,32 +167,32 @@ export const MULTIPLE_MODIFIERS_RULES: ReadonlyArray<
   },
 ];
 export const PHRASE_RULE: ReadonlyArray<(phrase: Phrase) => boolean> = [
-  // Disallow preverb modifiers other than "ala"
+  // disallow preverb modifiers other than "ala"
   (phrase) =>
     phrase.type !== "preverb" || modifiersIsAlaOrNone(phrase.modifiers) ||
     throwError(
       new UnrecognizedError('preverb with modifiers other than "ala"'),
     ),
 
-  // No multiple number words
+  // disallow multiple number words
   (phrase) =>
     phrase.type !== "default" ||
     phrase.headWord.type !== "number" ||
     !phrase.modifiers.some(modifierIsNumeric) ||
     throwError(new UnrecognizedError("multiple number words")),
 
-  // If the phrase has no modifiers, avoid emphasis particle
+  // if the phrase has no modifiers, disallow emphasis particle
   (phrase) =>
     phrase.type !== "default" ||
     phrase.emphasis == null ||
     phrase.modifiers.length > 0,
 
-  // For preverbs, inner phrase must not have emphasis particle
+  // for preverbs, inner phrase must not have emphasis particle
   (phrase) =>
     phrase.type !== "preverb" ||
     !phraseHasTopLevelEmphasis(phrase.phrase),
 
-  // Emphasis must not be nested
+  // emphasis must not be nested
   (phrase) =>
     phrase.emphasis == null ||
     everyWordUnitInPhrase(phrase)
@@ -201,29 +201,29 @@ export const PHRASE_RULE: ReadonlyArray<(phrase: Phrase) => boolean> = [
 ];
 export const PREPOSITION_RULE: ReadonlyArray<(phrase: Preposition) => boolean> =
   [
-    // Disallow preverb modifiers other than "ala"
+    // disallow preverb modifiers other than "ala"
     (preposition) =>
       modifiersIsAlaOrNone(preposition.modifiers) ||
       throwError(
         new UnrecognizedError('preverb with modifiers other than "ala"'),
       ),
 
-    // Disallow nested preposition
+    // disallow nested preposition
     (preposition) =>
       !everyPhraseInMultiplePhrases(preposition.phrases)
         .some(hasPrepositionInPhrase) ||
       throwError(new UnrecognizedError("preposition inside preposition")),
 
-    // Preposition with "anu" must not have emphasis particle
+    // preposition with "anu" must not have emphasis particle
     (preposition) =>
       preposition.emphasis == null || preposition.phrases.type !== "anu",
 
-    // Inner phrase must not have emphasis particle
+    // inner phrase must not have emphasis particle
     (preposition) =>
       preposition.phrases.type !== "single" ||
       !phraseHasTopLevelEmphasis(preposition.phrases.phrase),
 
-    // Emphasis must not be nested
+    // emphasis must not be nested
     (preposition) =>
       preposition.emphasis == null ||
       everyWordUnitInPreposition(preposition)
@@ -233,10 +233,10 @@ export const PREPOSITION_RULE: ReadonlyArray<(phrase: Preposition) => boolean> =
 export const CONTEXT_CLAUSE_RULE: ReadonlyArray<
   (contextClause: ContextClause) => boolean
 > = [
-  // Only allow "anu la" when allowed by the settings
+  // only allow "anu la" when allowed by the settings
   (clause) => clause.type !== "anu" || settings.hardcodedAnuLa,
 
-  // Prevent "anu ala anu la"
+  // disallow "anu ala anu la"
   (clause) =>
     clause.type !== "anu" || clause.anu.type !== "x ala x" ||
     throwError(new UnrecognizedError('"anu ala anu la"')),
@@ -309,7 +309,7 @@ export const CLAUSE_RULE: ReadonlyArray<(clause: Clause) => boolean> = [
   },
 ];
 export const SENTENCE_RULE: ReadonlyArray<(sentence: Sentence) => boolean> = [
-  // Prevent "taso ala taso" or "kin ala kin"
+  // disallow "taso ala taso" or "kin ala kin"
   (sentence) => {
     if (sentence.type === "default") {
       if (
@@ -322,7 +322,7 @@ export const SENTENCE_RULE: ReadonlyArray<(sentence: Sentence) => boolean> = [
     }
     return true;
   },
-  // If there is "la", there can't be starting particle e.g. taso
+  // if there is "la", there can't be starting particle e.g. taso
   (sentence) =>
     sentence.type !== "default" || sentence.contextClauses.length === 0 ||
     sentence.startingParticle == null || throwError(
@@ -331,7 +331,7 @@ export const SENTENCE_RULE: ReadonlyArray<(sentence: Sentence) => boolean> = [
       ),
     ),
 
-  // There can't be more than 1 "x ala x" or "seme"
+  // there can't be more than 1 "x ala x" or "seme"
   (sentence) => {
     if (sentence.interrogative != null) {
       const interrogative = everyWordUnitInSentence(sentence)
@@ -358,7 +358,7 @@ export const SENTENCE_RULE: ReadonlyArray<(sentence: Sentence) => boolean> = [
 export const MULTIPLE_SENTENCES_RULE: ReadonlyArray<
   (sentences: ReadonlyArray<Sentence>) => boolean
 > = [
-  // Only allow at most 2 sentences
+  // only allow at most 2 sentences
   (sentences) =>
     sentences.filter(({ type }) => type !== "filler").length <= 2 ||
     throwError(new UnrecognizedError("multiple sentences")),

src/parser/parser_lib.ts

@@ -180,7 +180,7 @@ export function sequence<T extends ReadonlyArray<unknown>>(
     1,
     "`sequence` called with less than 2 arguments",
   );
-  // We resorted to using `any` types here, make sure it works properly
+  // we resorted to using `any` types here, make sure it works properly
   return sequence.reduceRight(
     (right: Parser<any>, left) =>
       left.then((value) => right.map((newValue) => [value, ...newValue])),

src/parser/test.ts

@@ -1,4 +1,4 @@
-// This code is Deno only
+// this code is Deno only
 
 import { assertEquals } from "@std/assert/equals";
 import { assertLess } from "@std/assert/less";

src/repl.ts

@@ -1,4 +1,4 @@
-// This code is Deno only
+// this code is Deno only
 
 import { unescape } from "@std/html/entities";
 import entityList from "@std/html/named-entity-list.json" with { type: "json" };

src/settings.ts

@@ -22,5 +22,5 @@ export const defaultSettings: Readonly<Settings> = Object.freeze({
   separateRepeatedModifiers: false,
   hardcodedAnuLa: true,
 });
-// This global constant is mutable
+// this global constant is mutable
 export const settings: Settings = Object.seal({ ...defaultSettings });

src/settings_frontend.ts

@@ -1,4 +1,4 @@
-// This code is browser only
+// this code is browser only
 
 import { toKebabCase } from "@std/text/to-kebab-case";
 import { checkLocalStorage, setIgnoreError } from "./local_storage.ts";

src/translator/test.ts

@@ -1,4 +1,4 @@
-// This code is Deno only
+// this code is Deno only
 
 import { assertArrayIncludes } from "@std/assert/array-includes";
 import { number } from "./number.ts";

telo_misikeke/Parser.js

@@ -1,10 +1,10 @@
-// This code is from https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/-/raw/main/public/Parser.js
+// this code is from https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/-/raw/main/public/Parser.js
 //
-// Repository: https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/
+// repository: https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/
 // Copyright (c) 2023 Nicolas Hurtubise
 // MIT License https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/#licence
 //
-// It is automatically modified to be an ES module
+// it is automatically modified to be an ES module
 
 /* Parser.js
  * written by Colin Kuebler 2012

telo_misikeke/rules.js

@@ -1,10 +1,10 @@
-// This code is from https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/-/raw/main/public/rules.js
+// this code is from https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/-/raw/main/public/rules.js
 //
-// Repository: https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/
+// repository: https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/
 // Copyright (c) 2023 Nicolas Hurtubise
 // MIT License https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/#licence
 //
-// It is automatically modified to be an ES module
+// it is automatically modified to be an ES module
 
 var getCategory;
 var getMessage;

telo_misikeke/update.ts

@@ -1,4 +1,4 @@
-// This code is Deno only
+// this code is Deno only
 
 import { retry } from "@std/async/retry";
 
@@ -40,13 +40,13 @@ async function buildCode(
   }
   const exports = exportItems.join(", ");
   const code = `\
-// This code is from ${source}
+// this code is from ${source}
 //
-// Repository: https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/
+// repository: https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/
 // Copyright (c) 2023 Nicolas Hurtubise
 // MIT License https://gitlab.com/telo-misikeke/telo-misikeke.gitlab.io/#licence
 //
-// It is automatically modified to be an ES module
+// it is automatically modified to be an ES module
 
 ${withoutCjs};
 export { ${exports} };