resistor-color-duo: allow non-optimal constants during analysis (#111)

* Fixes #101

Allow for non-optimal constants. We currently don't provided messages about the
constants themselves, so instead, when not checking for the optimal solution,
continue with sub-optimal constants as well.

Before:

```javascript
export const COLORS = [
  'black',
  'brown',
  'red',
  'orange',
  'yellow',
  'green',
  'blue',
  'violet',
  'grey',
  'White',
]
// => Helper is not optimal
```

The helper was marked as non-optimal, where it was actually the referenced
constant that was not optimal.

* Read prettier from package.json

* Remove explicit out-of-sync prettier from workflows

* Apply formatting

Author: SleeplessByte

.github/workflows/format-code.yml

@@ -62,8 +62,6 @@ jobs:
 
       - name: 'Format code'
         run: ./bin/format.sh
-        env:
-          EXERCISM_PRETTIER_VERSION: '2.2.1'
 
       - name: 'Commit formatted code'
         run: |

.github/workflows/verify-code-formatting.yml

@@ -14,5 +14,3 @@ jobs:
 
       - name: 'Verify formatting of all files'
         run: ./bin/check-formatting.sh
-        env:
-          EXERCISM_PRETTIER_VERSION: '2.2.1'

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.15.0
+
+- Allow non-optimal constants in `resistor-color-duo`
+
 ## 0.14.0
 
 - Update dependencies

README.md

@@ -15,21 +15,21 @@ yarn install
 
 You'll need at least Node LTS for this to work.
 
-```
+```bash
 yarn build
 ```
 
 ## Usage
 
 You can run this either via `yarn`:
 
-```
+```bash
 yarn analyze:bat --debug --console two-fer ~/path/to/solution/folder
 ```
 
 Or directly via the provided shell script:
 
-```
+```bash
 ./bin/analyze.sh --debug --console two-fer ~/path/to/solution/folder
 ```
 

bin/check-formatting.sh

@@ -1,3 +1,16 @@
 #!/bin/bash
 
+if [ -z "$EXERCISM_PRETTIER_VERSION" ]; then
+	echo "Pulling prettier version from package.json"
+	EXERCISM_PRETTIER_VERSION=$(npm list prettier | grep -Po '.*prettier@\K.*')
+fi
+
+if [ -z "$EXERCISM_PRETTIER_VERSION" ]; then
+	echo "This script requires the EXERCISM_PRETTIER_VERSION variable to work."
+	echo "Please see https://github.com/exercism/v3/blob/master/docs/maintainers/style-guide.md for guidance."
+	exit 1
+else
+	echo "Running format with prettier@$EXERCISM_PRETTIER_VERSION"
+fi
+
 npx "prettier@$EXERCISM_PRETTIER_VERSION" --check "**/*.{js,jsx,ts,tsx,css,sass,scss,html,json,md,yml}"

bin/format.sh

@@ -1,9 +1,16 @@
 #!/usr/bin/env bash
 
+if [ -z "$EXERCISM_PRETTIER_VERSION" ]; then
+	echo "Pulling prettier version from package.json"
+	EXERCISM_PRETTIER_VERSION=$(npm list prettier | grep -Po '.*prettier@\K.*')
+fi
+
 if [ -z "$EXERCISM_PRETTIER_VERSION" ]; then
 	echo "This script requires the EXERCISM_PRETTIER_VERSION variable to work."
 	echo "Please see https://github.com/exercism/v3/blob/master/docs/maintainers/style-guide.md for guidance."
 	exit 1
+else
+	echo "Running format with prettier@$EXERCISM_PRETTIER_VERSION"
 fi
 
 npx "prettier@$EXERCISM_PRETTIER_VERSION" --write "**/*.{js,jsx,ts,tsx,css,sass,scss,html,json,md,yml}"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exercism/javascript-analyzer",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "Exercism analyzer for javascript",
   "repository": "https://github.com/exercism/javascript-analyzer",
   "author": "Derk-Jan Karrenbeld <[email protected]>",
@@ -51,6 +51,7 @@
     "eslint-plugin-import": "^2.24.2",
     "eslint-plugin-jest": "^24.4.0",
     "jest": "^27.1.0",
+    "prettier": "^2.3.2",
     "rimraf": "^3.0.2",
     "shelljs": "^0.8.4"
   },

src/analyzers/practice/gigasecond/GigasecondSolution.ts

@@ -68,9 +68,8 @@ class Constant {
       return !!this._memoized['isOptimisedComprehension']
     }
 
-    return (this._memoized[
-      'isOptimisedComprehension'
-    ] = isOptimisedComprehension(init))
+    return (this._memoized['isOptimisedComprehension'] =
+      isOptimisedComprehension(init))
   }
 
   public get isLargeNumberLiteral(): boolean {
@@ -299,13 +298,13 @@ export class GigasecondSolution {
     this.mainExport = assertNamedExport(EXPECTED_EXPORT, exports)
 
     // All constants at the top level that are _not_ the main method
-    this.fileConstants = findTopLevelConstants(program, ([
+    this.fileConstants = findTopLevelConstants(program, [
       'let',
       'const',
       'var',
 
       // TODO upstream bug
-    ] as unknown) as ['let']).filter(
+    ] as unknown as ['let']).filter(
       (declaration): boolean =>
         declaration &&
         guardIdentifier(declaration.id) &&

src/analyzers/practice/resistor-color-duo/ResistorColorDuoSolution.ts

@@ -27,6 +27,7 @@ import { assertNamedExport } from '~src/asserts/assert_named_export'
 import { assertNamedFunction } from '~src/asserts/assert_named_function'
 import { extractSignature } from '~src/extracts/extract_declaration'
 import { extractNamedFunction } from '~src/extracts/extract_named_function'
+import { guardLiteralCaseInsensitive } from '../../utils/guard_literal_case_insensitive'
 
 type Node = TSESTree.Node
 type Program = TSESTree.Program
@@ -129,6 +130,36 @@ class Constant {
     return false
   }
 
+  public get isNonOptimalArray(): boolean {
+    const { init } = this.constant
+
+    if (!init) {
+      return false
+    }
+
+    const literals = [
+      'black',
+      'brown',
+      'red',
+      'orange',
+      'yellow',
+      'green',
+      'blue',
+      'violet',
+      'grey',
+      'white',
+    ]
+
+    if (init.type === AST_NODE_TYPES.ArrayExpression) {
+      // Each literal needs to be present, and needs to be present exactly in this order
+      return init.elements.every((value, index): boolean =>
+        guardLiteralCaseInsensitive(value, literals[index])
+      )
+    }
+
+    return false
+  }
+
   public get isObjectToArray(): boolean {
     const { init } = this.constant
 
@@ -179,6 +210,39 @@ class Constant {
     })
   }
 
+  public isNonOptimalObject(
+    node: ExtractedVariable | undefined = this.constant
+  ): boolean {
+    if (!node || !node.init) {
+      return false
+    }
+
+    if (node.init.type !== AST_NODE_TYPES.ObjectExpression) {
+      return false
+    }
+
+    const keys = [
+      'black',
+      'brown',
+      'red',
+      'orange',
+      'yellow',
+      'green',
+      'blue',
+      'violet',
+      'grey',
+      'white',
+    ]
+
+    return node.init.properties.every((property, index): boolean => {
+      return (
+        property.type === AST_NODE_TYPES.Property &&
+        guardLiteralCaseInsensitive(property.key, keys[index]) &&
+        guardLiteral(property.value, index)
+      )
+    })
+  }
+
   /**
    * In the case that the top-level constant is constructed from Object.keys(argument),
    * this property holds the name of the "argument".
@@ -315,15 +379,19 @@ class Entry {
 
   public get hasFor(): boolean {
     return (
-      findFirst(this.body, (node): node is
-        | TSESTree.ForInStatement
-        | TSESTree.ForOfStatement
-        | TSESTree.ForStatement =>
-        [
-          AST_NODE_TYPES.ForInStatement,
-          AST_NODE_TYPES.ForOfStatement,
-          AST_NODE_TYPES.ForStatement,
-        ].some((type) => type === node.type)
+      findFirst(
+        this.body,
+        (
+          node
+        ): node is
+          | TSESTree.ForInStatement
+          | TSESTree.ForOfStatement
+          | TSESTree.ForStatement =>
+          [
+            AST_NODE_TYPES.ForInStatement,
+            AST_NODE_TYPES.ForOfStatement,
+            AST_NODE_TYPES.ForStatement,
+          ].some((type) => type === node.type)
       ) !== undefined
     )
   }
@@ -961,7 +1029,7 @@ class Entry {
       return false
     }
 
-    if (constant.isOptimalArray) {
+    if (constant.isOptimalArray || constant.isNonOptimalArray) {
       logger.log('=> constant is optimal array')
 
       // Only looking for:
@@ -977,7 +1045,7 @@ class Entry {
       )
     }
 
-    if (constant.isOptimalObject()) {
+    if (constant.isOptimalObject() || constant.isNonOptimalObject()) {
       logger.log('=> constant is optimal object')
 
       // Only looking for:
@@ -1023,13 +1091,13 @@ export class ResistorColorDuoSolution {
     this.mainExport = assertNamedExport(EXPECTED_EXPORT, exports)
 
     // All constants at the top level that are _not_ the main method
-    this.fileConstants = findTopLevelConstants(program, ([
+    this.fileConstants = findTopLevelConstants(program, [
       'let',
       'const',
       'var',
 
       // TODO upstream bug
-    ] as unknown) as ['let']).filter(
+    ] as unknown as ['let']).filter(
       (declaration): boolean =>
         declaration &&
         guardIdentifier(declaration.id) &&

src/analyzers/practice/resistor-color/ResistorColorSolution.ts

@@ -230,15 +230,19 @@ class Entry {
 
   public get hasFor(): boolean {
     return (
-      findFirst(this.body, (node): node is
-        | TSESTree.ForInStatement
-        | TSESTree.ForOfStatement
-        | TSESTree.ForStatement =>
-        [
-          AST_NODE_TYPES.ForInStatement,
-          AST_NODE_TYPES.ForOfStatement,
-          AST_NODE_TYPES.ForStatement,
-        ].some((type) => type === node.type)
+      findFirst(
+        this.body,
+        (
+          node
+        ): node is
+          | TSESTree.ForInStatement
+          | TSESTree.ForOfStatement
+          | TSESTree.ForStatement =>
+          [
+            AST_NODE_TYPES.ForInStatement,
+            AST_NODE_TYPES.ForOfStatement,
+            AST_NODE_TYPES.ForStatement,
+          ].some((type) => type === node.type)
       ) !== undefined
     )
   }
@@ -400,13 +404,13 @@ export class ResistorColorSolution {
     }
 
     // All constants at the top level that are _not_ the main method
-    this.fileConstants = findTopLevelConstants(program, ([
+    this.fileConstants = findTopLevelConstants(program, [
       'let',
       'const',
       'var',
 
       // TODO: bug in upstream
-    ] as unknown) as ['let']).filter(
+    ] as unknown as ['let']).filter(
       (declaration): boolean =>
         declaration &&
         guardIdentifier(declaration.id) &&