@cedarjs/structure 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Cedar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,145 @@
+**IMPORTANT:** This is an **internal** and **development-time only** package :exclamation:
+
+# Overview
+
+- The @redwoodjs/structure package lets you build, validate and inspect an object graph that represents a complete Redwood project
+- It is used by the CLI and by VSCode extensions to provide IDE features such as diagnostics, code-fixes, etc.
+- **IMPORTANT:** This is an **internal** and **development-time only** package
+  - You **cannot** "import it" into a normal redwood app
+
+## Code
+
+- `/model/*`: The main API and classes (such as RWProject, RWPage, RWService, etc)
+- `/language_server/*`: A [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) implementation that wraps the `model` classes. More info [here](./src/language_server/README.md)
+- We use [vscode-languageserver-types](https://www.npmjs.com/package/vscode-languageserver-types) where possible (to represent Document URIs, Positions, Ranges, Diagnostics, etc)
+
+# Usage
+
+## Diagnostics
+
+The most common use-case is getting the diagnostics of a complete Redwood project:
+
+```ts
+import { getProject } from '@cedarjs/structure'
+async function test() {
+  const project = getProject('/path/to/app') // or "file:///path/to/app"
+  for (const d of await project.collectDiagnostics()) {
+    console.log(d.diagnostic.severity + ': ' + d.diagnostic.message)
+  }
+}
+// ...
+// error: Router must have only one "notfound" page
+// error: Duplicate path in router: '/about-us'
+// error: Parameter "id" in route '/product/{id}' does not exist on ProductPage
+// error: PostsCell is missing the "Success" exported const
+// error: Property "email" does not exist on "User" model
+// warning: Unused page AboutUs.js
+```
+
+Note: Gathering _all_ diagnostics is expensive. It will trigger the creation of the complete project graph.
+
+## Exploration
+
+You can also traverse the graph to get more detailed information on multiple aspects of your app.
+
+For example, iterating over the routes of a Redwood project:
+
+```ts
+import { getProject } from '@cedarjs/structure'
+async function test() {
+  const project = getProject('/path/to/app')
+  for (const route of project.router.routes) {
+    console.log(route.path + (route.isPrivate ? ' (private)' : ''))
+  }
+}
+// /
+// /about
+// /product/{id}
+// /admin (private)
+```
+
+# Design Notes
+
+- The project is represented by an AST of sorts (via the RWProject, RWRoute, etc classes)
+- While it can be explored as a graph, it is effectively a **tree** (via the children/parent properties) with stable IDs for each node
+- Nodes are created lazily as the user traverses properties.
+- There is extensive caching going on under the hood. **If the underlying project changes, you need to create a new project**
+
+## ids
+
+- Each node in the graph has an `id` property.
+- ids are unique and stable
+- They are organized in a hierarchical fashion (so that `child.id.startsWith(parent.id) === true`)
+- Requesting a node using its id will not require the complete project to be processed. Only the subset that is needed (usually only the node's ancestors). This is important to enable efficient IDE-like tooling to interact with the project graph and get diagnostics for quickly changing files.
+
+```ts
+import { getProject } from '@cedarjs/structure'
+async function test() {
+  const project = getProject('/path/to/app')
+  const router = await project.findNode('file:///path/to/app/web/src/Routes.js')
+  console.log(router.routes.length)
+}
+```
+
+Here are some examples of ids:
+
+- (Project)
+  - id: `"file:///project/root"`
+    - router: (Router)
+      - id: `"file:///project/root/web/src/Routes.js"`
+      - routes[0]: (Route)
+        - id: `"file:///project/root/web/src/Routes.js /home"` (notice that this id has two elements - it is an "internal" node)
+
+An id is "usually" a file or folder.
+
+Anatomy of an id:
+
+- An id is a string.
+- It has components separated by spaces.
+- The first component is always a file URI (or folder URI).
+- The rest are optional, and only exist when the node is internal to a file.
+
+## Abstracting File System Access
+
+To allow use cases like dealing with unsaved files in IDEs, some filesystem methods can be overridden via the Host interface.
+
+```ts
+import { Host, getProject } from '@cedarjs/structure'
+const myHost: Host {
+  readFileSync(path:string){
+    // ...
+  }
+  // ...
+}
+const project = getProject('/path/to/project', myHost)
+```
+
+## Sync VS Async
+
+When possible, the project graph is constructed synchronously. There are only a few exceptions. This simplifies the domain logic and validations, which is the main driver behind the project model itself.
+
+## Parsing Invalid Projects
+
+- It is possible to obtain a graph for an invalid/malformed Redwood project. This is by design since one of the main goals of this package is to provide a foundation for IDEs, which must support projects in invalid states
+- If you want to check for structural validity, gather all diagnostics and look for errors.
+
+```ts
+import { getProject, DiagnosticSeverity } from '@cedarjs/structure'
+async function test() {
+  try {
+    const project = getProject('/path/to/app')
+    const diagnostics = await project.collectDiagnostics()
+    const hasErrors = diagnostics.some(
+      (d) => d.diagnostic.severity === DiagnosticSeverity.Error,
+    )
+  } catch (e) {
+    // we caught a runtime error
+    // in some cases this is the desired behavior
+    // but in MOST cases we SHOULD turn this into a diagnostic error
+    // please file an issue if you believe this should be the case
+    throw e
+  }
+}
+```
+
+NOTE: It is possible (and very likely at this point) that this package will sometimes fail with a runtime error (for example, it will try to read a file that doesn't exist).

package/dist/errors.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Stable error codes
+ * TODO: use numbers? they tend to be more resilient to changes.
+ */
+export declare enum RWError {
+    SERVICE_NOT_IMPLEMENTED = "SERVICE_NOT_IMPLEMENTED",
+    NOTFOUND_PAGE_NOT_DEFINED = "NOTFOUND_PAGE_NOT_DEFINED",
+    INVALID_ROUTE_PATH_SYNTAX = "INVALID_ROUTE_PATH_SYNTAX",
+    SCHEMA_NOT_DEFINED = "SCHEMA_NOT_DEFINED"
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,OAAO;IACjB,uBAAuB,4BAA4B;IACnD,yBAAyB,8BAA8B;IAEvD,yBAAyB,8BAA8B;IACvD,kBAAkB,uBAAuB;CAC1C"}

package/dist/errors.js

@@ -0,0 +1,19 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js/object/define-property");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.RWError = void 0;
+/**
+ * Stable error codes
+ * TODO: use numbers? they tend to be more resilient to changes.
+ */
+let RWError = exports.RWError = /*#__PURE__*/function (RWError) {
+  RWError["SERVICE_NOT_IMPLEMENTED"] = "SERVICE_NOT_IMPLEMENTED";
+  RWError["NOTFOUND_PAGE_NOT_DEFINED"] = "NOTFOUND_PAGE_NOT_DEFINED";
+  // this error should be broken down into more specialized errors: syntax error, duplicate parameters
+  RWError["INVALID_ROUTE_PATH_SYNTAX"] = "INVALID_ROUTE_PATH_SYNTAX";
+  RWError["SCHEMA_NOT_DEFINED"] = "SCHEMA_NOT_DEFINED";
+  return RWError;
+}({});

package/dist/hosts.d.ts

@@ -0,0 +1,23 @@
+import type { Paths } from '@cedarjs/project-config';
+/**
+ * The host interface allows us to decouple the "model/*"
+ * classes from access to the file system.
+ * This is critical for editor support (ex: showing diagnostics on unsaved files)
+ */
+export interface Host {
+    existsSync(path: string): boolean;
+    readFileSync(path: string): string;
+    readdirSync(path: string): string[];
+    globSync(pattern: string): string[];
+    writeFileSync(path: string, contents: string): void;
+    paths: Paths;
+}
+export declare class DefaultHost implements Host {
+    existsSync(path: string): boolean;
+    readFileSync(path: string): string;
+    readdirSync(path: string): string[];
+    globSync(pattern: string): string[];
+    writeFileSync(path: string, contents: string): void;
+    get paths(): Paths;
+}
+//# sourceMappingURL=hosts.d.ts.map

package/dist/hosts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hosts.d.ts","sourceRoot":"","sources":["../src/hosts.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAKpD;;;;GAIG;AACH,MAAM,WAAW,IAAI;IACnB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IACjC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IAClC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACnC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACnD,KAAK,EAAE,KAAK,CAAA;CACb;AAED,qBAAa,WAAY,YAAW,IAAI;IACtC,UAAU,CAAC,IAAI,EAAE,MAAM;IAGvB,YAAY,CAAC,IAAI,EAAE,MAAM;IAGzB,WAAW,CAAC,IAAI,EAAE,MAAM;IAGxB,QAAQ,CAAC,OAAO,EAAE,MAAM;IAIxB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAG5C,IACI,KAAK,UAER;CACF"}

package/dist/hosts.js

@@ -0,0 +1,45 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js/object/define-property");
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DefaultHost = void 0;
+var _replaceAll = _interopRequireDefault(require("@babel/runtime-corejs3/core-js/instance/replace-all"));
+var _getOwnPropertyDescriptor = _interopRequireDefault(require("@babel/runtime-corejs3/core-js/object/get-own-property-descriptor"));
+var _applyDecoratedDescriptor2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/applyDecoratedDescriptor"));
+var _fastGlob = _interopRequireDefault(require("fast-glob"));
+var fs = _interopRequireWildcard(require("fs-extra"));
+var _projectConfig = require("@cedarjs/project-config");
+var _decorators = require("./x/decorators");
+var _dec, _class;
+/**
+ * The host interface allows us to decouple the "model/*"
+ * classes from access to the file system.
+ * This is critical for editor support (ex: showing diagnostics on unsaved files)
+ */
+let DefaultHost = exports.DefaultHost = (_dec = (0, _decorators.lazy)(), _class = class DefaultHost {
+  existsSync(path) {
+    return fs.existsSync(path);
+  }
+  readFileSync(path) {
+    return fs.readFileSync(path, {
+      encoding: 'utf8'
+    }).toString();
+  }
+  readdirSync(path) {
+    return fs.readdirSync(path);
+  }
+  globSync(pattern) {
+    // globSync only works with / as the path separator, even on Windows
+    return _fastGlob.default.sync((0, _replaceAll.default)(pattern).call(pattern, '\\', '/'));
+  }
+  writeFileSync(path, contents) {
+    return fs.writeFileSync(path, contents);
+  }
+  get paths() {
+    return (0, _projectConfig.getPaths)();
+  }
+}, (0, _applyDecoratedDescriptor2.default)(_class.prototype, "paths", [_dec], (0, _getOwnPropertyDescriptor.default)(_class.prototype, "paths"), _class.prototype), _class);

package/dist/ide.d.ts

@@ -0,0 +1,122 @@
+import type * as tsm from 'ts-morph';
+import type { TextDocuments } from 'vscode-languageserver';
+import type { TextDocument } from 'vscode-languageserver-textdocument';
+import type { CodeLens, DocumentLink, Hover, Location } from 'vscode-languageserver-types';
+import type { Host } from './hosts';
+import { DefaultHost } from './hosts';
+import type { ArrayLike } from './x/Array';
+import type { ExtendedDiagnostic } from './x/vscode-languageserver-types';
+export type NodeID = string;
+export type IDEInfo = Definition | Implementation | Reference | CodeLensX | HoverX | Decoration | DocumentLinkX;
+export interface Definition {
+    kind: 'Definition';
+    location: Location;
+    target: Location;
+}
+export interface Implementation {
+    kind: 'Implementation';
+    location: Location;
+    target: Location;
+}
+export interface Reference {
+    kind: 'Reference';
+    location: Location;
+    target: Location;
+}
+export interface CodeLensX {
+    kind: 'CodeLens';
+    location: Location;
+    codeLens: CodeLens;
+}
+export interface HoverX {
+    kind: 'Hover';
+    location: Location;
+    hover: Hover;
+}
+export interface Decoration {
+    kind: 'Decoration';
+    location: Location;
+    style: 'path_punctuation' | 'path_parameter' | 'path_slash' | 'path_parameter_type';
+}
+export interface DocumentLinkX {
+    kind: 'DocumentLink';
+    location: Location;
+    link: DocumentLink;
+}
+export declare abstract class BaseNode {
+    /**
+     * Each node MUST have a unique ID.
+     * IDs have meaningful information.
+     *
+     * examples:
+     * - /path/to/project
+     * - /path/to/project/web/src/Routes.js
+     * - /path/to/project/web/src/Routes.js /route1
+     */
+    abstract get id(): NodeID;
+    abstract get parent(): BaseNode | undefined;
+    get host(): Host;
+    exists: boolean;
+    /**
+     * Returns the children of this node.
+     * Override this.
+     */
+    children(): ArrayLike<BaseNode>;
+    private _children;
+    /**
+     * Diagnostics for this node (must not include children's diagnostics).
+     * Override this.
+     */
+    diagnostics(): ArrayLike<ExtendedDiagnostic>;
+    private _diagnostics;
+    /**
+     * IDE info for this node.
+     * Override this.
+     */
+    ideInfo(): ArrayLike<IDEInfo>;
+    private _ideInfo;
+    collectIDEInfo(uri?: string): Promise<IDEInfo[]>;
+    /**
+     * Collects diagnostics for this node and all descendants.
+     * This is what you'll use to gather all the project diagnostics.
+     */
+    collectDiagnostics(uri?: string): Promise<ExtendedDiagnostic[]>;
+    bailOutOnCollection(uri: string): boolean;
+    get closestContainingUri(): string | undefined;
+    /**
+     * Finds a node by ID.
+     * The default algorithm tries to be economic and only create the necessary
+     * intermediate nodes.
+     * Subclasses can override this to add further optimizations.
+     * @param id
+     */
+    findNode(id: NodeID): Promise<BaseNode | undefined>;
+}
+export declare abstract class FileNode extends BaseNode {
+    abstract get filePath(): string;
+    get uri(): string;
+    /**
+     * the ID of a FileNode is its file:// uri.
+     */
+    get id(): string;
+    get text(): string;
+    get fileExists(): boolean;
+    /**
+     * parsed ts-morph source file
+     */
+    get sf(): tsm.SourceFile;
+    get basenameNoExt(): string;
+    get basename(): string;
+}
+export declare class HostWithDocumentsStore implements Host {
+    documents: TextDocuments<TextDocument>;
+    defaultHost: DefaultHost;
+    constructor(documents: TextDocuments<TextDocument>);
+    readFileSync(path: string): string;
+    existsSync(path: string): boolean;
+    readdirSync(path: string): string[];
+    globSync(pattern: string): string[];
+    writeFileSync(path: string, contents: string): void;
+    get paths(): import("@cedarjs/project-config").Paths;
+}
+//# sourceMappingURL=ide.d.ts.map

package/dist/ide.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ide.d.ts","sourceRoot":"","sources":["../src/ide.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,GAAG,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AACtE,OAAO,KAAK,EACV,QAAQ,EACR,YAAY,EACZ,KAAK,EACL,QAAQ,EACT,MAAM,6BAA6B,CAAA;AAGpC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAM1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAEzE,MAAM,MAAM,MAAM,GAAG,MAAM,CAAA;AAE3B,MAAM,MAAM,OAAO,GACf,UAAU,GACV,cAAc,GACd,SAAS,GACT,SAAS,GACT,MAAM,GACN,UAAU,GACV,aAAa,CAAA;AAEjB,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,YAAY,CAAA;IAClB,QAAQ,EAAE,QAAQ,CAAA;IAClB,MAAM,EAAE,QAAQ,CAAA;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,gBAAgB,CAAA;IACtB,QAAQ,EAAE,QAAQ,CAAA;IAClB,MAAM,EAAE,QAAQ,CAAA;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,WAAW,CAAA;IACjB,QAAQ,EAAE,QAAQ,CAAA;IAClB,MAAM,EAAE,QAAQ,CAAA;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,UAAU,CAAA;IAChB,QAAQ,EAAE,QAAQ,CAAA;IAClB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,OAAO,CAAA;IACb,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,KAAK,CAAA;CACb;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,YAAY,CAAA;IAClB,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EACD,kBAAkB,GAClB,gBAAgB,GAChB,YAAY,GACZ,qBAAqB,CAAA;CAC1B;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,cAAc,CAAA;IACpB,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,YAAY,CAAA;CACnB;AAED,8BAAsB,QAAQ;IAC5B;;;;;;;;OAQG;IACH,QAAQ,KAAK,EAAE,IAAI,MAAM,CAAA;IACzB,QAAQ,KAAK,MAAM,IAAI,QAAQ,GAAG,SAAS,CAAA;IAE3C,IACI,IAAI,IAAI,IAAI,CAOf;IACD,MAAM,UAAO;IACb;;;OAGG;IACH,QAAQ,IAAI,SAAS,CAAC,QAAQ,CAAC;IAGvB,OAAO,CAAC,SAAS;IAIzB;;;OAGG;IACH,WAAW,IAAI,SAAS,CAAC,kBAAkB,CAAC;IAGpC,OAAO,CAAC,YAAY;IAI5B;;;OAGG;IACH,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC;IAGrB,OAAO,CAAC,QAAQ;IAKlB,cAAc,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAsBtD;;;OAGG;IAEG,kBAAkB,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAgCrE,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAUzC,IAAY,oBAAoB,IAAI,MAAM,GAAG,SAAS,CASrD;IAED;;;;;;OAMG;IAEG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;CAgB1D;AAED,8BAAsB,QAAS,SAAQ,QAAQ;IAC7C,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAA;IAC/B,IAAY,GAAG,IAAI,MAAM,CAExB;IACD;;OAEG;IACH,IAAY,EAAE,WAEb;IACD,IAAY,IAAI,WAEf;IACD,IAAY,UAAU,IAAI,OAAO,CAEhC;IACD;;OAEG;IACH,IAAY,EAAE,IAAI,GAAG,CAAC,UAAU,CAK/B;IACD,IAAY,aAAa,WAExB;IACD,IAAY,QAAQ,WAEnB;CACF;AAED,qBAAa,sBAAuB,YAAW,IAAI;IAE9B,SAAS,EAAE,aAAa,CAAC,YAAY,CAAC;IADzD,WAAW,cAAoB;gBACZ,SAAS,EAAE,aAAa,CAAC,YAAY,CAAC;IACzD,YAAY,CAAC,IAAI,EAAE,MAAM;IAQzB,UAAU,CAAC,IAAI,EAAE,MAAM;IAGvB,WAAW,CAAC,IAAI,EAAE,MAAM;IAGxB,QAAQ,CAAC,OAAO,EAAE,MAAM;IAGxB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAG5C,IAAI,KAAK,4CAER;CACF"}

package/dist/ide.js

@@ -0,0 +1,240 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js/object/define-property");
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.HostWithDocumentsStore = exports.FileNode = exports.BaseNode = void 0;
+var _stringify = _interopRequireDefault(require("@babel/runtime-corejs3/core-js/json/stringify"));
+var _promise = _interopRequireDefault(require("@babel/runtime-corejs3/core-js/promise"));
+var _map = _interopRequireDefault(require("@babel/runtime-corejs3/core-js/instance/map"));
+var _flat = _interopRequireDefault(require("@babel/runtime-corejs3/core-js/instance/flat"));
+var _filter = _interopRequireDefault(require("@babel/runtime-corejs3/core-js/instance/filter"));
+var _startsWith = _interopRequireDefault(require("@babel/runtime-corejs3/core-js/instance/starts-with"));
+var _getOwnPropertyDescriptor = _interopRequireDefault(require("@babel/runtime-corejs3/core-js/object/get-own-property-descriptor"));
+var _applyDecoratedDescriptor2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/applyDecoratedDescriptor"));
+var _path = require("path");
+var _vscodeLanguageserverTypes = require("vscode-languageserver-types");
+var _hosts = require("./hosts");
+var _Array = require("./x/Array");
+var _decorators = require("./x/decorators");
+var _path2 = require("./x/path");
+var _tsMorph = require("./x/ts-morph");
+var _URL = require("./x/URL");
+var _dec, _dec2, _dec3, _dec4, _dec5, _dec6, _dec7, _dec8, _class, _dec9, _dec10, _dec11, _dec12, _dec13, _dec14, _dec15, _class2;
+let BaseNode = exports.BaseNode = (_dec = (0, _decorators.lazy)(), _dec2 = (0, _decorators.memo)(), _dec3 = (0, _decorators.memo)(), _dec4 = (0, _decorators.memo)(), _dec5 = (0, _decorators.memo)(_stringify.default), _dec6 = (0, _decorators.memo)(_stringify.default), _dec7 = (0, _decorators.lazy)(), _dec8 = (0, _decorators.memo)(), _class = class BaseNode {
+  constructor() {
+    this.exists = true;
+  }
+  /**
+   * Each node MUST have a unique ID.
+   * IDs have meaningful information.
+   *
+   * examples:
+   * - /path/to/project
+   * - /path/to/project/web/src/Routes.js
+   * - /path/to/project/web/src/Routes.js /route1
+   */
+  get host() {
+    if (this.parent) {
+      return this.parent.host;
+    }
+    throw new Error("Could not find host implementation on root node (you must override the 'host' getter)");
+  }
+  /**
+   * Returns the children of this node.
+   * Override this.
+   */
+  children() {
+    return [];
+  }
+  _children() {
+    return (0, _Array.ArrayLike_normalize)(this.children());
+  }
+
+  /**
+   * Diagnostics for this node (must not include children's diagnostics).
+   * Override this.
+   */
+  diagnostics() {
+    return [];
+  }
+  _diagnostics() {
+    return (0, _Array.ArrayLike_normalize)(this.diagnostics());
+  }
+
+  /**
+   * IDE info for this node.
+   * Override this.
+   */
+  ideInfo() {
+    return [];
+  }
+  _ideInfo() {
+    return (0, _Array.ArrayLike_normalize)(this.ideInfo());
+  }
+  async collectIDEInfo(uri) {
+    if (uri && this.bailOutOnCollection(uri)) {
+      return [];
+    }
+    try {
+      var _context;
+      const d1 = await this._ideInfo();
+      const dd = await _promise.default.all((0, _map.default)(_context = await this._children()).call(_context, c => c.collectIDEInfo(uri)));
+      const d2 = (0, _flat.default)(dd).call(dd);
+      let all = [...d1, ...d2];
+      if (uri) {
+        all = (0, _filter.default)(all).call(all, x => x.location.uri === uri);
+      }
+      return all;
+    } catch (e) {
+      // TODO: this diagnostic is also interesting
+      console.log(e);
+      return [];
+    }
+  }
+
+  /**
+   * Collects diagnostics for this node and all descendants.
+   * This is what you'll use to gather all the project diagnostics.
+   */
+  async collectDiagnostics(uri) {
+    // TODO: catch runtime errors and add them as diagnostics
+    // TODO: we can parallelize this further
+    if (uri && this.bailOutOnCollection(uri)) {
+      return [];
+    }
+    try {
+      var _context2;
+      const d1 = await this._diagnostics();
+      const dd = await _promise.default.all((0, _map.default)(_context2 = await this._children()).call(_context2, c => c.collectDiagnostics(uri)));
+      const d2 = (0, _flat.default)(dd).call(dd);
+      let all = [...d1, ...d2];
+      if (uri) {
+        all = (0, _filter.default)(all).call(all, x => x.uri === uri);
+      }
+      return all;
+    } catch (e) {
+      const uri = this.closestContainingUri;
+      if (!uri) {
+        throw e;
+      }
+      const range = _vscodeLanguageserverTypes.Range.create(0, 0, 0, 0);
+      return [{
+        uri,
+        diagnostic: {
+          message: e + '',
+          range
+        }
+      }];
+    }
+  }
+  bailOutOnCollection(uri) {
+    if (this.id === uri) {
+      return false;
+    }
+    if ((0, _startsWith.default)(uri).call(uri, this.id)) {
+      return false;
+    }
+    return true;
+  }
+  get closestContainingUri() {
+    const {
+      uri
+    } = this;
+    if (uri) {
+      return uri;
+    }
+    if (this.parent) {
+      return this.parent.closestContainingUri;
+    }
+    return undefined;
+  }
+
+  /**
+   * Finds a node by ID.
+   * The default algorithm tries to be economic and only create the necessary
+   * intermediate nodes.
+   * Subclasses can override this to add further optimizations.
+   * @param id
+   */
+  async findNode(id) {
+    id = (0, _URL.URL_file)(id);
+    if (this.id === id) {
+      return this;
+    }
+    if ((0, _startsWith.default)(id).call(id, this.id)) {
+      for (const c of await this._children()) {
+        // depth first search by default
+        const cc = await c.findNode(id);
+        if (cc) {
+          return cc;
+        }
+      }
+    }
+    return undefined;
+  }
+}, (0, _applyDecoratedDescriptor2.default)(_class.prototype, "host", [_dec], (0, _getOwnPropertyDescriptor.default)(_class.prototype, "host"), _class.prototype), (0, _applyDecoratedDescriptor2.default)(_class.prototype, "_children", [_dec2], (0, _getOwnPropertyDescriptor.default)(_class.prototype, "_children"), _class.prototype), (0, _applyDecoratedDescriptor2.default)(_class.prototype, "_diagnostics", [_dec3], (0, _getOwnPropertyDescriptor.default)(_class.prototype, "_diagnostics"), _class.prototype), (0, _applyDecoratedDescriptor2.default)(_class.prototype, "_ideInfo", [_dec4], (0, _getOwnPropertyDescriptor.default)(_class.prototype, "_ideInfo"), _class.prototype), (0, _applyDecoratedDescriptor2.default)(_class.prototype, "collectIDEInfo", [_dec5], (0, _getOwnPropertyDescriptor.default)(_class.prototype, "collectIDEInfo"), _class.prototype), (0, _applyDecoratedDescriptor2.default)(_class.prototype, "collectDiagnostics", [_dec6], (0, _getOwnPropertyDescriptor.default)(_class.prototype, "collectDiagnostics"), _class.prototype), (0, _applyDecoratedDescriptor2.default)(_class.prototype, "closestContainingUri", [_dec7], (0, _getOwnPropertyDescriptor.default)(_class.prototype, "closestContainingUri"), _class.prototype), (0, _applyDecoratedDescriptor2.default)(_class.prototype, "findNode", [_dec8], (0, _getOwnPropertyDescriptor.default)(_class.prototype, "findNode"), _class.prototype), _class);
+let FileNode = exports.FileNode = (_dec9 = (0, _decorators.lazy)(), _dec10 = (0, _decorators.lazy)(), _dec11 = (0, _decorators.lazy)(), _dec12 = (0, _decorators.lazy)(), _dec13 = (0, _decorators.lazy)(), _dec14 = (0, _decorators.lazy)(), _dec15 = (0, _decorators.lazy)(), _class2 = class FileNode extends BaseNode {
+  get uri() {
+    return (0, _URL.URL_file)(this.filePath);
+  }
+  /**
+   * the ID of a FileNode is its file:// uri.
+   */
+  get id() {
+    return this.uri;
+  }
+  get text() {
+    return this.host.readFileSync(this.filePath);
+  }
+  get fileExists() {
+    return this.host.existsSync(this.filePath);
+  }
+  /**
+   * parsed ts-morph source file
+   */
+  get sf() {
+    if (typeof this.text === 'undefined') {
+      throw new Error('undefined file ' + this.filePath);
+    }
+    return (0, _tsMorph.createTSMSourceFile_cached)(this.filePath, this.text);
+  }
+  get basenameNoExt() {
+    return (0, _path2.basenameNoExt)(this.filePath);
+  }
+  get basename() {
+    return (0, _path.basename)(this.filePath);
+  }
+}, (0, _applyDecoratedDescriptor2.default)(_class2.prototype, "uri", [_dec9], (0, _getOwnPropertyDescriptor.default)(_class2.prototype, "uri"), _class2.prototype), (0, _applyDecoratedDescriptor2.default)(_class2.prototype, "id", [_dec10], (0, _getOwnPropertyDescriptor.default)(_class2.prototype, "id"), _class2.prototype), (0, _applyDecoratedDescriptor2.default)(_class2.prototype, "text", [_dec11], (0, _getOwnPropertyDescriptor.default)(_class2.prototype, "text"), _class2.prototype), (0, _applyDecoratedDescriptor2.default)(_class2.prototype, "fileExists", [_dec12], (0, _getOwnPropertyDescriptor.default)(_class2.prototype, "fileExists"), _class2.prototype), (0, _applyDecoratedDescriptor2.default)(_class2.prototype, "sf", [_dec13], (0, _getOwnPropertyDescriptor.default)(_class2.prototype, "sf"), _class2.prototype), (0, _applyDecoratedDescriptor2.default)(_class2.prototype, "basenameNoExt", [_dec14], (0, _getOwnPropertyDescriptor.default)(_class2.prototype, "basenameNoExt"), _class2.prototype), (0, _applyDecoratedDescriptor2.default)(_class2.prototype, "basename", [_dec15], (0, _getOwnPropertyDescriptor.default)(_class2.prototype, "basename"), _class2.prototype), _class2);
+class HostWithDocumentsStore {
+  constructor(documents) {
+    this.defaultHost = new _hosts.DefaultHost();
+    this.documents = documents;
+  }
+  readFileSync(path) {
+    const uri = (0, _URL.URL_file)(path);
+    const doc = this.documents.get(uri);
+    if (doc) {
+      return doc.getText();
+    }
+    return this.defaultHost.readFileSync(path);
+  }
+  existsSync(path) {
+    return this.defaultHost.existsSync(path);
+  }
+  readdirSync(path) {
+    return this.defaultHost.readdirSync(path);
+  }
+  globSync(pattern) {
+    return this.defaultHost.globSync(pattern);
+  }
+  writeFileSync(path, contents) {
+    return this.defaultHost.writeFileSync(path, contents);
+  }
+  get paths() {
+    return this.defaultHost.paths;
+  }
+}
+exports.HostWithDocumentsStore = HostWithDocumentsStore;

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export { DiagnosticSeverity } from 'vscode-languageserver-types';
+export { DefaultHost, Host } from './hosts';
+export { RWProject } from './model';
+export { URL_file } from './x/URL';
+import { DefaultHost } from './hosts';
+import { RWProject } from './model';
+import type { GetSeverityLabelFunction } from './x/vscode-languageserver-types';
+export declare function getProject(projectRoot: string, host?: DefaultHost): RWProject;
+export declare function printDiagnostics(projectRoot: string, opts?: {
+    getSeverityLabel?: GetSeverityLabelFunction;
+}): Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AACnC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAG/E,wBAAgB,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,cAAoB,aAKvE;AAED,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE;IAAE,gBAAgB,CAAC,EAAE,wBAAwB,CAAA;CAAE,iBA8BvD"}