wrec 0.35.1 → 0.35.3

package/package.json

@@ -2,7 +2,7 @@
   "name": "wrec",
   "description": "a library that greatly simplifies building web components",
   "author": "R. Mark Volkmann",
-  "version": "0.35.1",
+  "version": "0.35.3",
   "license": "MIT",
   "repository": {
     "type": "git",

package/scripts/declare.js

@@ -83,7 +83,12 @@ function analyzeSourceFile(sourceFile) {
 }
 
 // Builds the `declare` block that should appear after `static properties`.
-function buildDeclareBlock(sourceFile, classNode, propertiesMember, declareLines) {
+function buildDeclareBlock(
+  sourceFile,
+  classNode,
+  propertiesMember,
+  declareLines
+) {
   const {text} = sourceFile;
   const memberIndent = getIndent(text, propertiesMember.getStart(sourceFile));
   const startIndex = classNode.members.indexOf(propertiesMember) + 1;
@@ -105,9 +110,7 @@ function buildDeclareBlock(sourceFile, classNode, propertiesMember, declareLines
     return nextMember ? `\n\n${nextIndent}` : '\n';
   }
 
-  const content = declareLines
-    .map(line => `${memberIndent}${line}`)
-    .join('\n');
+  const content = declareLines.map(line => `${memberIndent}${line}`).join('\n');
   return nextMember ? `\n${content}\n\n${nextIndent}` : `\n${content}\n`;
 }
 
@@ -138,15 +141,12 @@ export function evaluateSourceFile(filePath, options = {}) {
 
 // Determines what changes, if any, should be made in source file text.
 export function evaluateSourceText(filePath, text) {
-  const scriptKind = filePath.endsWith('.ts')
-    ? ts.ScriptKind.TS
-    : ts.ScriptKind.JS;
   const sourceFile = ts.createSourceFile(
     filePath,
     text,
     ts.ScriptTarget.Latest,
     true,
-    scriptKind
+    ts.ScriptKind.TS
   );
   return analyzeSourceFile(sourceFile);
 }
@@ -258,8 +258,8 @@ function validateFile(absFilePath) {
   const stat = fs.statSync(absFilePath);
   if (!stat.isFile()) throw new Error('Not a file');
 
-  if (!/\.(js|ts)$/.test(absFilePath) || /\.d\.ts$/.test(absFilePath)) {
-    throw new Error('Unsupported file type');
+  if (!/\.ts$/.test(absFilePath)) {
+    throw new Error('validate statements can only be added in .ts files');
   }
 }
 

package/scripts/lint.js

@@ -1602,6 +1602,23 @@ function requiresContextFunction(symbol, sourceFile) {
   });
 }
 
+// Returns whether a type represents an object-like value other than an array.
+function isNonArrayObjectLikeType(checker, type) {
+  if (type.isUnion()) {
+    return type.types.every(member => isNonArrayObjectLikeType(checker, member));
+  }
+
+  if (type.isIntersection()) {
+    return type.types.every(member => isNonArrayObjectLikeType(checker, member));
+  }
+
+  return (
+    Boolean(type.flags & (ts.TypeFlags.Object | ts.TypeFlags.NonPrimitive)) &&
+    !checker.isArrayType(type) &&
+    !checker.isTupleType(type)
+  );
+}
+
 // Resolves a relative import path to an existing source file.
 function resolveImportPath(baseDir, importPath) {
   if (!importPath.startsWith('.')) return undefined;
@@ -1622,6 +1639,22 @@ function toUserFacingExpression(text) {
   return text.replaceAll(WREC_REF_NAME, 'this');
 }
 
+// Returns whether a static property config type is compatible with a declare type.
+function typeExpressionMatchesDeclaredType(
+  checker,
+  typeExpression,
+  declaredTypeNode
+) {
+  const declaredType = checker.getTypeFromTypeNode(declaredTypeNode);
+
+  if (typeExpressionKind(typeExpression) === 'Object') {
+    return isNonArrayObjectLikeType(checker, declaredType);
+  }
+
+  const runtimeType = checker.getTypeAtLocation(typeExpression);
+  return checker.isTypeAssignableTo(runtimeType, declaredType);
+}
+
 // Classifies a constructor-based type expression by its identifier name.
 function typeExpressionKind(expression) {
   if (!expression) return undefined;
@@ -1776,11 +1809,7 @@ function validateDefaultValue(checker, typeExpression, valueExpression) {
   }
 
   if (typeKind === 'Object') {
-    const isObjectLike =
-      Boolean(valueType.flags & ts.TypeFlags.Object) &&
-      !checker.isArrayType(valueType) &&
-      !checker.isTupleType(valueType);
-    if (!isObjectLike) {
+    if (!isNonArrayObjectLikeType(checker, valueType)) {
       return {typeName: 'Object', valueTypeName};
     }
   }
@@ -1942,9 +1971,7 @@ function validatePropertyConfigs(
           'Boolean, Number, String, Object, or Array'
       );
     } else if (declaredTypeNode) {
-      const runtimeType = checker.getTypeAtLocation(typeExpression);
-      const declaredType = checker.getTypeFromTypeNode(declaredTypeNode);
-      if (!checker.isTypeAssignableTo(runtimeType, declaredType)) {
+      if (!typeExpressionMatchesDeclaredType(checker, typeExpression, declaredTypeNode)) {
         findings.incompatibleDeclareTypes.push(
           `property "${propName}" declare type ` +
             `"${getPropertyTypeTextFromNode(sourceFile, declaredTypeNode)}" ` +

package/scripts/used-by.js

@@ -723,7 +723,7 @@ function validateFile(absFilePath) {
   const stat = fs.statSync(absFilePath);
   if (!stat.isFile()) throw new Error('Not a file');
 
-  if (!/\.(js|ts)$/.test(absFilePath) || /\.d\.ts$/.test(absFilePath)) {
+  if (!/\.(js|ts)$/.test(absFilePath)) {
     throw new Error('Unsupported file type');
   }
 }