@opetope/lint 0.11.0 → 0.12.1

package/dist/rules/when-predicate.d.ts

@@ -1,6 +0,0 @@
-import type { TSESLint } from '@typescript-eslint/utils';
-type MessageIds = 'whenIsAsync' | 'whenReturnsBareSource' | 'whenReturnsSource';
-declare const whenPredicate: TSESLint.RuleModule<MessageIds, [], unknown, TSESLint.RuleListener> & {
-    name: string;
-};
-export { whenPredicate };

package/dist/rules/when-predicate.js

@@ -1,2 +0,0 @@
-import{AST_NODE_TYPES as i}from"@typescript-eslint/utils";import{propertyName as m,isFunctionLike as l,calleeName as y,patternKeys as c,memberRoot as h,memberFirstStep as S}from"../ast.js";import{createRule as I}from"../rule.js";const b=new Set(["pipe","register","slot"]),x=new Set(["exports","imports","own","read"]),w=new Set(["exports","imports","own"]);function T(n){const{parent:e}=n;if(e.type!==i.CallExpression||e.arguments.length<2)return!1;const t=y(e);return t!==void 0&&b.has(t)&&e.arguments.at(-1)===n}function d(n){const[e]=n.params;if(!(n.params.length!==1||e?.type!==i.ObjectPattern))return[...c(e)].some(t=>x.has(t))?e:void 0}function g(n){const[e]=n.params;if(!(n.params.length!==1||e?.type!==i.Identifier))return e}function A(n,e){const t=h(e),r=S(e);return t.type!==i.Identifier||t.name!==n.name?!1:r!==void 0&&w.has(r)}function E(n,e){const t=h(e);return t.type!==i.Identifier?!1:w.has(t.name)&&c(n).has(t.name)}function R(n,e){const t=d(n);if(t!==void 0)return E(t,e)?"read":void 0;const r=g(n);if(r!==void 0)return A(r,e)?`${r.name}.read`:void 0}function O(n,e){const t=e.properties.find(s=>{const a=m(s);return a===void 0||a>"read"});if(t!==void 0)return n.insertTextBefore(t,"read, ");const r=e.properties.at(-1);return r===void 0?void 0:n.insertTextAfter(r,", read")}function C(n,e){return n.params.some(t=>t.type===i.Identifier&&t.name===e.name)}function N(n,e){const{parent:t}=n;return t.type===i.ObjectExpression&&T(t)||d(e)!==void 0}const B=I({create(n){const e=(r,s)=>{const a=R(r,s);a!==void 0&&n.report({fix(p){const o=d(r),u=p.replaceText(s,`${a}(${n.sourceCode.getText(s)})`);if(o===void 0||c(o).has("read"))return[u];const f=O(p,o);return f===void 0?[u]:[u,f]},messageId:"whenReturnsSource",node:s})},t=r=>{if(r.async){n.report({messageId:"whenIsAsync",node:r});return}if(r.type!==i.ArrowFunctionExpression)return;const{body:s}=r;if(s.type===i.MemberExpression){e(r,s);return}s.type===i.Identifier&&!C(r,s)&&n.report({messageId:"whenReturnsBareSource",node:s})};return{Property(r){m(r)!=="when"||!l(r.value)||N(r,r.value)&&t(r.value)}}},meta:{docs:{description:"A contribution `when` predicate answers the visibility fact, not the source that carries it."},fixable:"code",messages:{whenIsAsync:"A contribution `when` predicate answers a boolean synchronously; an asynchronous one answers a promise (D220).",whenReturnsBareSource:"A contribution `when` takes a `Readable<boolean>` as it is; a predicate must answer the fact with `read(...)` (D220).",whenReturnsSource:"A contribution `when` predicate returns the source instead of the fact; read it with `read(...)` (D220)."},schema:[],type:"problem"},name:"when-predicate"});export{B as whenPredicate};
-//# sourceMappingURL=when-predicate.js.map

package/dist/rules/when-predicate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"when-predicate.js","sources":["../../src/rules/when-predicate.ts"],"sourcesContent":["import type { TSESLint, TSESTree } from '@typescript-eslint/utils';\nimport { AST_NODE_TYPES } from '@typescript-eslint/utils';\n\nimport type { FunctionLike } from '../ast';\nimport { calleeName, isFunctionLike, memberFirstStep, memberRoot, patternKeys, propertyName } from '../ast';\nimport { createRule } from '../rule';\n\ntype MessageIds = 'whenIsAsync' | 'whenReturnsBareSource' | 'whenReturnsSource';\n\nconst CONTRIBUTION_BUILDERS = new Set(['pipe', 'register', 'slot']);\nconst CONTEXT_KEYS = new Set(['exports', 'imports', 'own', 'read']);\nconst CONTEXT_SOURCES = new Set(['exports', 'imports', 'own']);\n\n/** The options object of `slot(target, contribution, {…})`, `pipe(target, {fold}, {…})`, `register(…)`. */\nfunction isBuilderOptions(node: TSESTree.ObjectExpression): boolean {\n  const { parent } = node;\n\n  if (parent.type !== AST_NODE_TYPES.CallExpression || parent.arguments.length < 2) return false;\n\n  const name = calleeName(parent);\n\n  return name !== undefined && CONTRIBUTION_BUILDERS.has(name) && parent.arguments.at(-1) === node;\n}\n\n/** The destructured evaluation context of a contribution predicate: `({ exports, imports, own, read })`. */\nfunction contextPattern(fn: FunctionLike): TSESTree.ObjectPattern | undefined {\n  const [parameter] = fn.params;\n\n  if (fn.params.length !== 1 || parameter?.type !== AST_NODE_TYPES.ObjectPattern) return undefined;\n\n  return [...patternKeys(parameter)].some(key => CONTEXT_KEYS.has(key)) ? parameter : undefined;\n}\n\n/** The same context taken as one named parameter: `context => context.imports.platform.submitAllowed`. */\nfunction contextIdentifier(fn: FunctionLike): TSESTree.Identifier | undefined {\n  const [parameter] = fn.params;\n\n  if (fn.params.length !== 1 || parameter?.type !== AST_NODE_TYPES.Identifier) return undefined;\n\n  return parameter;\n}\n\nfunction isNamedContextAccess(parameter: TSESTree.Identifier, body: TSESTree.MemberExpression): boolean {\n  const root = memberRoot(body);\n  const step = memberFirstStep(body);\n\n  if (root.type !== AST_NODE_TYPES.Identifier || root.name !== parameter.name) return false;\n\n  return step !== undefined && CONTEXT_SOURCES.has(step);\n}\n\nfunction isDestructuredContextAccess(pattern: TSESTree.ObjectPattern, body: TSESTree.MemberExpression): boolean {\n  const root = memberRoot(body);\n\n  if (root.type !== AST_NODE_TYPES.Identifier) return false;\n\n  return CONTEXT_SOURCES.has(root.name) && patternKeys(pattern).has(root.name);\n}\n\n/** The reader a fix would call, or `undefined` when the body reaches something other than the instance context. */\nfunction readerFor(fn: FunctionLike, body: TSESTree.MemberExpression): string | undefined {\n  const pattern = contextPattern(fn);\n\n  if (pattern !== undefined) return isDestructuredContextAccess(pattern, body) ? 'read' : undefined;\n\n  const parameter = contextIdentifier(fn);\n\n  if (parameter === undefined) return undefined;\n\n  return isNamedContextAccess(parameter, body) ? `${parameter.name}.read` : undefined;\n}\n\n/** `read` joins the destructured context in place, so the fixed predicate keeps the order authors write. */\nfunction insertReadKey(fixer: TSESLint.RuleFixer, pattern: TSESTree.ObjectPattern): TSESLint.RuleFix | undefined {\n  const successor = pattern.properties.find(property => {\n    const name = propertyName(property);\n\n    return name === undefined || name > 'read';\n  });\n\n  if (successor !== undefined) return fixer.insertTextBefore(successor, 'read, ');\n\n  const last = pattern.properties.at(-1);\n\n  return last === undefined ? undefined : fixer.insertTextAfter(last, ', read');\n}\n\nfunction isOwnParameter(fn: FunctionLike, identifier: TSESTree.Identifier): boolean {\n  return fn.params.some(\n    parameter => parameter.type === AST_NODE_TYPES.Identifier && parameter.name === identifier.name,\n  );\n}\n\nfunction isContributionWhen(property: TSESTree.Property, fn: FunctionLike): boolean {\n  const { parent } = property;\n\n  return (\n    (parent.type === AST_NODE_TYPES.ObjectExpression && isBuilderOptions(parent)) || contextPattern(fn) !== undefined\n  );\n}\n\nconst whenPredicate = createRule<[], MessageIds>({\n  create(context) {\n    const reportSource = (fn: FunctionLike, body: TSESTree.MemberExpression): void => {\n      const reader = readerFor(fn, body);\n\n      if (reader === undefined) return;\n\n      context.report({\n        fix(fixer) {\n          const pattern = contextPattern(fn);\n          const wrapped = fixer.replaceText(body, `${reader}(${context.sourceCode.getText(body)})`);\n\n          if (pattern === undefined || patternKeys(pattern).has('read')) return [wrapped];\n\n          const inserted = insertReadKey(fixer, pattern);\n\n          return inserted === undefined ? [wrapped] : [wrapped, inserted];\n        },\n        messageId: 'whenReturnsSource',\n        node: body,\n      });\n    };\n\n    const check = (fn: FunctionLike): void => {\n      if (fn.async) {\n        context.report({ messageId: 'whenIsAsync', node: fn });\n\n        return;\n      }\n\n      if (fn.type !== AST_NODE_TYPES.ArrowFunctionExpression) return;\n\n      const { body } = fn;\n\n      if (body.type === AST_NODE_TYPES.MemberExpression) {\n        reportSource(fn, body);\n\n        return;\n      }\n\n      if (body.type === AST_NODE_TYPES.Identifier && !isOwnParameter(fn, body)) {\n        context.report({ messageId: 'whenReturnsBareSource', node: body });\n      }\n    };\n\n    return {\n      Property(node): void {\n        if (propertyName(node) !== 'when' || !isFunctionLike(node.value)) return;\n\n        if (isContributionWhen(node, node.value)) check(node.value);\n      },\n    };\n  },\n  meta: {\n    docs: {\n      description: 'A contribution `when` predicate answers the visibility fact, not the source that carries it.',\n    },\n    fixable: 'code',\n    messages: {\n      whenIsAsync:\n        'A contribution `when` predicate answers a boolean synchronously; an asynchronous one answers a promise (D220).',\n      whenReturnsBareSource:\n        'A contribution `when` takes a `Readable<boolean>` as it is; a predicate must answer the fact with `read(...)` (D220).',\n      whenReturnsSource:\n        'A contribution `when` predicate returns the source instead of the fact; read it with `read(...)` (D220).',\n    },\n    schema: [],\n    type: 'problem',\n  },\n  name: 'when-predicate',\n});\n\nexport { whenPredicate };\n"],"names":["CONTRIBUTION_BUILDERS","CONTEXT_KEYS","CONTEXT_SOURCES","isBuilderOptions","node","parent","AST_NODE_TYPES","name","calleeName","contextPattern","fn","parameter","patternKeys","key","contextIdentifier","isNamedContextAccess","body","root","memberRoot","step","memberFirstStep","isDestructuredContextAccess","pattern","readerFor","insertReadKey","fixer","successor","property","propertyName","last","isOwnParameter","identifier","isContributionWhen","whenPredicate","createRule","context","reportSource","reader","wrapped","inserted","check","isFunctionLike"],"mappings":"qOASA,MAAMA,EAAwB,IAAI,IAAI,CAAC,OAAQ,WAAY,MAAM,CAAC,EAC5DC,EAAe,IAAI,IAAI,CAAC,UAAW,UAAW,MAAO,MAAM,CAAC,EAC5DC,EAAkB,IAAI,IAAI,CAAC,UAAW,UAAW,KAAK,CAAC,EAG7D,SAASC,EAAiBC,EAA+B,CACvD,KAAM,CAAE,OAAAC,CAAM,EAAKD,EAEnB,GAAIC,EAAO,OAASC,EAAe,gBAAkBD,EAAO,UAAU,OAAS,EAAG,MAAO,GAEzF,MAAME,EAAOC,EAAWH,CAAM,EAE9B,OAAOE,IAAS,QAAaP,EAAsB,IAAIO,CAAI,GAAKF,EAAO,UAAU,GAAG,EAAE,IAAMD,CAC9F,CAGA,SAASK,EAAeC,EAAgB,CACtC,KAAM,CAACC,CAAS,EAAID,EAAG,OAEvB,GAAI,EAAAA,EAAG,OAAO,SAAW,GAAKC,GAAW,OAASL,EAAe,eAEjE,MAAO,CAAC,GAAGM,EAAYD,CAAS,CAAC,EAAE,KAAKE,GAAOZ,EAAa,IAAIY,CAAG,CAAC,EAAIF,EAAY,MACtF,CAGA,SAASG,EAAkBJ,EAAgB,CACzC,KAAM,CAACC,CAAS,EAAID,EAAG,OAEvB,GAAI,EAAAA,EAAG,OAAO,SAAW,GAAKC,GAAW,OAASL,EAAe,YAEjE,OAAOK,CACT,CAEA,SAASI,EAAqBJ,EAAgCK,EAA+B,CAC3F,MAAMC,EAAOC,EAAWF,CAAI,EACtBG,EAAOC,EAAgBJ,CAAI,EAEjC,OAAIC,EAAK,OAASX,EAAe,YAAcW,EAAK,OAASN,EAAU,KAAa,GAE7EQ,IAAS,QAAajB,EAAgB,IAAIiB,CAAI,CACvD,CAEA,SAASE,EAA4BC,EAAiCN,EAA+B,CACnG,MAAMC,EAAOC,EAAWF,CAAI,EAE5B,OAAIC,EAAK,OAASX,EAAe,WAAmB,GAE7CJ,EAAgB,IAAIe,EAAK,IAAI,GAAKL,EAAYU,CAAO,EAAE,IAAIL,EAAK,IAAI,CAC7E,CAGA,SAASM,EAAUb,EAAkBM,EAA+B,CAClE,MAAMM,EAAUb,EAAeC,CAAE,EAEjC,GAAIY,IAAY,OAAW,OAAOD,EAA4BC,EAASN,CAAI,EAAI,OAAS,OAExF,MAAML,EAAYG,EAAkBJ,CAAE,EAEtC,GAAIC,IAAc,OAElB,OAAOI,EAAqBJ,EAAWK,CAAI,EAAI,GAAGL,EAAU,IAAI,QAAU,MAC5E,CAGA,SAASa,EAAcC,EAA2BH,EAA+B,CAC/E,MAAMI,EAAYJ,EAAQ,WAAW,KAAKK,GAAW,CACnD,MAAMpB,EAAOqB,EAAaD,CAAQ,EAElC,OAAOpB,IAAS,QAAaA,EAAO,MACtC,CAAC,EAED,GAAImB,IAAc,OAAW,OAAOD,EAAM,iBAAiBC,EAAW,QAAQ,EAE9E,MAAMG,EAAOP,EAAQ,WAAW,GAAG,EAAE,EAErC,OAAOO,IAAS,OAAY,OAAYJ,EAAM,gBAAgBI,EAAM,QAAQ,CAC9E,CAEA,SAASC,EAAepB,EAAkBqB,EAA+B,CACvE,OAAOrB,EAAG,OAAO,KACfC,GAAaA,EAAU,OAASL,EAAe,YAAcK,EAAU,OAASoB,EAAW,IAAI,CAEnG,CAEA,SAASC,EAAmBL,EAA6BjB,EAAgB,CACvE,KAAM,CAAE,OAAAL,CAAM,EAAKsB,EAEnB,OACGtB,EAAO,OAASC,EAAe,kBAAoBH,EAAiBE,CAAM,GAAMI,EAAeC,CAAE,IAAM,MAE5G,CAEA,MAAMuB,EAAgBC,EAA2B,CAC/C,OAAOC,EAAO,CACZ,MAAMC,EAAe,CAAC1B,EAAkBM,IAAyC,CAC/E,MAAMqB,EAASd,EAAUb,EAAIM,CAAI,EAE7BqB,IAAW,QAEfF,EAAQ,OAAO,CACb,IAAIV,EAAK,CACP,MAAMH,EAAUb,EAAeC,CAAE,EAC3B4B,EAAUb,EAAM,YAAYT,EAAM,GAAGqB,CAAM,IAAIF,EAAQ,WAAW,QAAQnB,CAAI,CAAC,GAAG,EAExF,GAAIM,IAAY,QAAaV,EAAYU,CAAO,EAAE,IAAI,MAAM,EAAG,MAAO,CAACgB,CAAO,EAE9E,MAAMC,EAAWf,EAAcC,EAAOH,CAAO,EAE7C,OAAOiB,IAAa,OAAY,CAACD,CAAO,EAAI,CAACA,EAASC,CAAQ,CAChE,EACA,UAAW,oBACX,KAAMvB,CACP,CAAA,CACH,EAEMwB,EAAS9B,GAA0B,CACvC,GAAIA,EAAG,MAAO,CACZyB,EAAQ,OAAO,CAAE,UAAW,cAAe,KAAMzB,EAAI,EAErD,MACF,CAEA,GAAIA,EAAG,OAASJ,EAAe,wBAAyB,OAExD,KAAM,CAAE,KAAAU,CAAI,EAAKN,EAEjB,GAAIM,EAAK,OAASV,EAAe,iBAAkB,CACjD8B,EAAa1B,EAAIM,CAAI,EAErB,MACF,CAEIA,EAAK,OAASV,EAAe,YAAc,CAACwB,EAAepB,EAAIM,CAAI,GACrEmB,EAAQ,OAAO,CAAE,UAAW,wBAAyB,KAAMnB,EAAM,CAErE,EAEA,MAAO,CACL,SAASZ,EAAI,CACPwB,EAAaxB,CAAI,IAAM,QAAU,CAACqC,EAAerC,EAAK,KAAK,GAE3D4B,EAAmB5B,EAAMA,EAAK,KAAK,GAAGoC,EAAMpC,EAAK,KAAK,CAC5D,EAEJ,EACA,KAAM,CACJ,KAAM,CACJ,YAAa,8FACd,EACD,QAAS,OACT,SAAU,CACR,YACE,iHACF,sBACE,wHACF,kBACE,0GACH,EACD,OAAQ,CAAA,EACR,KAAM,SACP,EACD,KAAM,gBACP,CAAA"}