@eagleoutice/eslint-config-flowr 2.1.6 → 2.1.7

package/README.md

@@ -80,7 +80,7 @@ The shipped set groups into families:
 | family | shape it finds | helper it points at |
 | :-- | :-- | :-- |
 | `edge-*` | `e.types === T`, `(e.types & T) !== 0`, and the bitmask spellings around them | `DfEdge` |
-| `vertex-is*`, `vertex-has-origin` | `v.tag === VertexType.X`, `Vertex.isFunctionCall(v) && v.origin.includes(o)` | `Vertex` |
+| `vertex-is*`, `vertex-has-origin` | `v.tag === VertexType.X`, `DfgVertex.isFunctionCall(v) && v.origin.includes(o)` | `DfgVertex` |
 | `node-is*` | `n.type === RType.X`, negated and through `?.` | `RSymbol`, `RFunctionCall`, and the rest of the `R*` node objects |
 | `argument-is-*`, `call-is-*`, `list-is-implicit` | a guard written out, `RFunctionCall.is(n) && n.named` | the narrower guard of the same object |
 | `symbol-name-comparison*` | `symbol.content === 'name'`, which misses `pkg::name` because an identifier with a namespace is an array | `Identifier.getName` / `Identifier.matches` |

package/index.js

@@ -105,14 +105,21 @@ const config = [
             '@stylistic/no-extra-semi': 'error',
             'jsdoc/check-alignment': 'error',
             /*
-             * the same alignment `key-spacing` asks of object values, asked of tsdoc: the `-` of every `@param`
-             * in a block lines up, so the names read as a column instead of as prose.
+             * `jsdoc/check-line-alignment` is deliberately NOT enabled. Lining up what the tags declare reads
+             * well, but 'always' reaches past the tags: it re-flows every hand-wrapped line to the margin, and
+             * that indentation is the author's and carries meaning -- a `@param` description hung under its
+             * first line, or the nested call in an R example that only its indentation ties to the call around
+             * it:
              *
-             * `disableWrapIndent` keeps its hands off every line after the first: a continuation is indented
-             * because the author meant something by it -- a hanging list, or a nested call in an R example
-             * whose indentation is what links it to the call around it -- and re-flowing that loses the point.
+             * ```r
+             * test_that("my test", {
+             *    assert_equal(1 + 1, 2)
+             * })
+             * ```
+             *
+             * Neither `preserveMainDescriptionPostDelimiter` nor `disableWrapIndent` stops it doing that to a
+             * tag's continuation lines, so the alignment is left to the author, like the delimiter style is.
              */
-            'jsdoc/check-line-alignment': ['error', 'always', { disableWrapIndent: true }],
             /* `@param name - what it is`, the spelling the codebase already uses everywhere */
             'jsdoc/require-hyphen-before-param-description': ['error', 'always'],
             'jsdoc/no-multi-asterisks': 'error',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eagleoutice/eslint-config-flowr",
-  "version": "2.1.6",
+  "version": "2.1.7",
   "description": "Linting rules for flowr and friends",
   "license": "ISC",
   "repository": {

package/patterns.js

@@ -84,12 +84,12 @@ const discriminatorIs = (id, { property, enumName, enumFile, propertyFile, helpe
     };
 };
 /**
- * `v.tag === VertexType.X`. One `Vertex` helper answers for every kind, and its members are named after the
- * enum, so `{{type|last}}` spells the check without a table: `VertexType.Use` to `Vertex.isUse`.
+ * `v.tag === VertexType.X`. One `DfgVertex` helper answers for every kind, and its members are named after
+ * the enum, so `{{type|last}}` spells the check without a table: `VertexType.Use` to `DfgVertex.isUse`.
  */
 const vertexIs = (id, options) => discriminatorIs(id, {
     property: 'tag', enumName: 'VertexType', enumFile: VERTEX, propertyFile: VERTEX,
-    helper: 'Vertex', member: 'is{{type|last}}', hint: 'Compare through the vertex helper'
+    helper: 'DfgVertex', member: 'is{{type|last}}', hint: 'Compare through the vertex helper'
 }, options);
 /**
  * `n.type === RType.X`. Every `RType` member has a helper object of the same name prefixed with `R`
@@ -220,15 +220,15 @@ const patterns = [
     {
         id: 'vertex-has-origin',
         selector: 'LogicalExpression[operator="&&"]'
-            + `${helperCall('left', 'Vertex', 'isFunctionCall')}`
+            + `${helperCall('left', 'DfgVertex', 'isFunctionCall')}`
             + `${call('right', 'includes')}[right.callee.object.type="MemberExpression"][right.callee.object.property.name="origin"]`,
         capture: { vertex: 'left.arguments.0', origin: 'right.arguments.0' },
-        replace: 'Vertex.hasOrigin({{vertex}}, {{origin}})',
+        replace: 'DfgVertex.hasOrigin({{vertex}}, {{origin}})',
         declaredIn: { 'left.callee.object': VERTEX, 'right.callee.object.property': VERTEX },
         sameText: [['left.arguments.0', 'right.callee.object.object']],
         /* `hasOrigin` is no type predicate, so the replacement can drop a narrowing the code below relies on */
         fix: false,
-        message: 'Use `Vertex.hasOrigin`, it is exactly this check. Check the narrowing first, `hasOrigin` returns a plain boolean.'
+        message: 'Use `DfgVertex.hasOrigin`, it is exactly this check. Check the narrowing first, `hasOrigin` returns a plain boolean.'
     },
     edgesFallback('graph-edges-from', 'outgoingEdges', 'edgesFrom'),
     edgesFallback('graph-edges-to', 'ingoingEdges', 'edgesTo'),