Switch to templated output by default (#40)

By changing the run flag from templates to noTemplates.

Author: SleeplessByte

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.2.0
+
+- Per https://github.com/exercism/automated-mentoring-support/issues/53,
+  Merge "approve_as_optimal" and "approve_with_comment" into a single status
+  "approve", and rename the "disapprove_with_comment" status to "disapprove".
+- Switch to template output by default (changing the run flag from templates to
+  noTemplates).
+
 ## 0.1.1
 
 Fixes the build and prepare step of the Docker-based image

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exercism/javascript-analyzer",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Exercism analyzer for javascript",
   "repository": "https://github.com/exercism/javascript-analyzer",
   "author": "Derk-Jan Karrenbeld <derk-jan+github@karrenbeld.info>",

src/analyzers/gigasecond/index.ts

@@ -23,6 +23,14 @@ import { isLiteral } from "../utils/is_literal"
 import { NO_METHOD, NO_NAMED_EXPORT, NO_PARAMETER, UNEXPECTED_PARAMETER } from "../../comments/shared";
 import { AstParser } from "../../parsers/AstParser";
 
+/**
+ * The factories here SHOULD be kept in sync with exercism/website-copy. Under
+ * normal use, they do NOT dictate the actual commentary output of the analyzer,
+ * as that is provided by the website-copy repo.
+ *
+ * https://github.com/exercism/website-copy/tree/master/automated-comments/javascript/gigasecond
+ */
+
 const TIP_EXPORT_INLINE = factory<'method-signature' | 'const.name'>`
 Did you know that you can export functions, classes and constants directly
 inline?

src/analyzers/resistor-color/index.ts

@@ -17,6 +17,14 @@ import { AstParser, ParsedSource } from "~src/parsers/AstParser";
 import { NoSourceError } from "~src/errors/NoSourceError";
 import { ParserError } from "~src/errors/ParserError";
 
+/**
+ * The factories here SHOULD be kept in sync with exercism/website-copy. Under
+ * normal use, they do NOT dictate the actual commentary output of the analyzer,
+ * as that is provided by the website-copy repo.
+ *
+ * https://github.com/exercism/website-copy/tree/master/automated-comments/javascript/resistor-color
+ */
+
 const TIP_EXPORT_INLINE = factory`
 Did you know that you can export functions, classes and constants directly
 inline?

src/analyzers/two-fer/index.ts

@@ -21,6 +21,14 @@ import { AstParser, ParsedSource } from "~src/parsers/AstParser";
 import { NoSourceError } from "~src/errors/NoSourceError";
 import { ParserError } from "~src/errors/ParserError";
 
+/**
+ * The factories here SHOULD be kept in sync with exercism/website-copy. Under
+ * normal use, they do NOT dictate the actual commentary output of the analyzer,
+ * as that is provided by the website-copy repo.
+ *
+ * https://github.com/exercism/website-copy/tree/master/automated-comments/javascript/two-fer
+ */
+
 const OPTIMISE_DEFAULT_VALUE = factory<'parameter'>`
 You currently use a conditional to branch in case there is no value passed into
 \`twoFer\`. Instead you could set the [default value](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Default_parameters)

src/comments/shared.ts

@@ -1,32 +1,40 @@
 import { factory } from "./comment"
 
+/**
+ * The factories here SHOULD be kept in sync with exercism/website-copy. Under
+ * normal use, they do NOT dictate the actual commentary output of the analyzer,
+ * as that is provided by the website-copy repo.
+ *
+ * https://github.com/exercism/website-copy/tree/master/automated-comments/javascript/general
+ */
+
 export const NO_METHOD = factory<'method.name'>`
 No method called \`${'method.name'}\`. The tests won't pass without it.
-`('javascript.generic.no_method')
+`('javascript.general.no_method')
 
 export const NO_NAMED_EXPORT = factory<'export.name'>`
 No [export](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export) called \`${'export.name'}\`.
 The tests won't pass without it.
 
 Did you forget adding: \`export ${'export.name'}\`?
-`('javascript.generic.no_named_export')
+`('javascript.general.no_named_export')
 
 export const NO_DEFAULT_EXPORT = factory`
 No [default](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/default)
 [export](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export).
 The tests won't pass without it.
 
 Did you forget adding: \`export default ...\`?
-`('javascript.generic.no_default_export')
+`('javascript.general.no_default_export')
 
 export const NO_PARAMETER = factory<'function.name'>`
 Your function \`${'function.name'}\` does not have a parameter.
 The tests won't pass without it.
-`('javascript.generic.no_parameter')
+`('javascript.general.no_parameter')
 
 export const UNEXPECTED_PARAMETER = factory<'type'>`
 Did not find a parameter of type \`${'type'}\`.
-`('javascript.generic.unexpected_parameter')
+`('javascript.general.unexpected_parameter')
 
 export const UNEXPECTED_SPLAT_ARGS = factory<'splat-arg.name' | 'parameter.type'>`
 Instead of using \`...${'splat-arg.name'}: ${'parameter.type'}[]\`, you should
@@ -35,7 +43,7 @@ define a parameter called \`${'splat-arg.name'}\` with the type \`${'parameter.t
 [Rest parameters / splat arguments](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/rest_parameters)
 are great if you don't know how many values you will receive and it can be an
 arbitrary number, but in this case you know how many values you want.
-`('javascript.generic.unexpected_splat_args')
+`('javascript.general.unexpected_splat_args')
 
 export const PREFER_TEMPLATED_STRINGS = factory`
 You're manually building a string using string concatenation. You can use a
@@ -46,7 +54,7 @@ instead and interpolate dynamic values:
 "Hello there \${firstName}, I will give you \${calculateInventory()} apples."
 \`\`\`
 
-`('typescrypt.generic.prefer_templated_strings')
+`('typescrypt.general.prefer_templated_strings')
 
 export const PREFER_STRICT_EQUALITY = factory`
 In _JavaScript_, always prefer [strict (identity and non-identity) equality](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comparison_Operators#Identity)
@@ -57,7 +65,7 @@ unless you explicitly want to coerce the type of one of the two operands.
 
 There are definitely cases where you'll want to use non-strict equality, but
 that's not the case in this exercise.
-`('javascript.generic.prefer_strict_equality')
+`('javascript.general.prefer_strict_equality')
 
 export const PREFER_UNPREFIXED_UNDERSCORE_PARAMETERS = factory<'parameter.name'>`
 Unlike other languages, \`_parameter\` does not signify a *private* variable.
@@ -76,4 +84,4 @@ Message: "${'error'}"
 \`\`\`
 ${'details'}
 \`\`\`
-`('javascript.generic.parse_error')
+`('javascript.general.parse_error')

src/interface.d.ts

@@ -11,8 +11,8 @@ interface ExecutionOptions {
   inputDir: string;
   /** The exercise slug */
   exercise: string;
-  /** If true, expects website-copy to provide the contents of the templates */
-  templates: boolean;
+  /** Unless true, expects website-copy to provide the contents of the templates */
+  noTemplates: boolean;
 }
 
 interface AstParser<T extends object> {

src/output/AnalyzerOutput.ts

@@ -80,11 +80,11 @@ export class AnalyzerOutput implements Output {
    * @param {ExecutionOptions} options
    * @returns {Promise<string>}
    */
-  public toProcessable({ templates }: Pick<ExecutionOptions, 'templates'>): Promise<string> {
+  public toProcessable({ noTemplates }: Pick<ExecutionOptions, 'noTemplates'>): Promise<string> {
     return Promise.resolve(
       JSON.stringify({
         status: this.status,
-        comments: this.comments.map(templates ? makeExternalComment : makeIsolatedComment)
+        comments: this.comments.map(noTemplates ? makeIsolatedComment : makeExternalComment)
       })
     )
   }

src/utils/execution_options.ts

@@ -7,7 +7,7 @@ export class ExecutionOptionsImpl implements ExecutionOptions {
   public inputDir!: string
   public exercise!: string
   public dry!: boolean
-  public templates!: boolean
+  public noTemplates!: boolean
 
   constructor(options: ExecutionOptions) {
     Object.assign(this, options);
@@ -23,26 +23,26 @@ export class ExecutionOptionsImpl implements ExecutionOptions {
       .describe('d', 'Unless given, only outputs warnings and errors')
       .describe('c', 'If given, outputs to the console')
       .describe('o', 'Path relative to the input dir where the analyzis results are stored')
-      .describe('templates', 'If given, exports templates instead of messages (feature flag)')
+      .describe('noTemplates', 'Unless given, exports templates instead of messages (feature flag)')
       .describe('dry', 'If given, does not output anything to disk')
-      .boolean(['d', 'c', 'dry', 'templates'])
+      .boolean(['d', 'c', 'dry', 'noTemplates'])
       .string('o')
       .default('d', process.env.NODE_ENV === 'development')
       .default('c', process.env.NODE_ENV === 'development')
-      .default('templates', false)
+      .default('noTemplates', false)
       .default('o', './analysis.json')
       .default('dry', false)
       .help('h')
       .alias('h', 'help')
       .argv
 
-    const { d, c, o, dry, templates, _ } = args
+    const { d, c, o, dry, noTemplates, _ } = args
     return new ExecutionOptionsImpl({
       debug: d,
       console: c,
       output: o,
       dry,
-      templates,
+      noTemplates,
       exercise: _[0],
       inputDir: _[1]
     })

test/analyzers/two-fer/__snapshots__/snapshot.ts.snap

@@ -93,15 +93,15 @@ exports[`When running analysis on two-fer fixtures and expecting it to disapprov
 AnalyzerOutput {
   "comments": Array [
     CommentImpl {
-      "externalTemplate": "javascript.generic.no_method",
+      "externalTemplate": "javascript.general.no_method",
       "message": "No method called \`twoFer\`. The tests won't pass without it.",
       "template": "No method called \`%<method.name>s\`. The tests won't pass without it.",
       "variables": Object {
         "method.name": "twoFer",
       },
     },
     CommentImpl {
-      "externalTemplate": "javascript.generic.no_named_export",
+      "externalTemplate": "javascript.general.no_named_export",
       "message": "No [export](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export) called \`twoFer\`.
 The tests won't pass without it.
 
@@ -163,7 +163,7 @@ exports[`When running analysis on two-fer fixtures and expecting it to disapprov
 AnalyzerOutput {
   "comments": Array [
     CommentImpl {
-      "externalTemplate": "javascript.generic.prefer_strict_equality",
+      "externalTemplate": "javascript.general.prefer_strict_equality",
       "message": "In _JavaScript_, always prefer [strict (identity and non-identity) equality](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comparison_Operators#Identity)
 such as \`===\` and \`!==\` over the forms that use implicit type coercion,
 such as [\`==\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comparison_Operators#Equality)
@@ -203,7 +203,7 @@ exports[`When running analysis on two-fer fixtures and expecting it to disapprov
 AnalyzerOutput {
   "comments": Array [
     CommentImpl {
-      "externalTemplate": "javascript.generic.prefer_strict_equality",
+      "externalTemplate": "javascript.general.prefer_strict_equality",
       "message": "In _JavaScript_, always prefer [strict (identity and non-identity) equality](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comparison_Operators#Identity)
 such as \`===\` and \`!==\` over the forms that use implicit type coercion,
 such as [\`==\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comparison_Operators#Equality)
@@ -325,7 +325,7 @@ exports[`When running analysis on two-fer fixtures and expecting it to disapprov
 AnalyzerOutput {
   "comments": Array [
     CommentImpl {
-      "externalTemplate": "javascript.generic.prefer_strict_equality",
+      "externalTemplate": "javascript.general.prefer_strict_equality",
       "message": "In _JavaScript_, always prefer [strict (identity and non-identity) equality](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comparison_Operators#Identity)
 such as \`===\` and \`!==\` over the forms that use implicit type coercion,
 such as [\`==\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comparison_Operators#Equality)
@@ -385,15 +385,15 @@ exports[`When running analysis on two-fer fixtures and expecting it to disapprov
 AnalyzerOutput {
   "comments": Array [
     CommentImpl {
-      "externalTemplate": "javascript.generic.no_method",
+      "externalTemplate": "javascript.general.no_method",
       "message": "No method called \`twoFer\`. The tests won't pass without it.",
       "template": "No method called \`%<method.name>s\`. The tests won't pass without it.",
       "variables": Object {
         "method.name": "twoFer",
       },
     },
     CommentImpl {
-      "externalTemplate": "javascript.generic.no_named_export",
+      "externalTemplate": "javascript.general.no_named_export",
       "message": "No [export](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export) called \`twoFer\`.
 The tests won't pass without it.