refactor: split into monorepo

.vault/.obsidian/plugins/data-entry/main.js

@@ -0,0 +1 @@
+/home/wayne/code/obsidian-plugin-data-entry/packages/data-entry/main.js

.vault/.obsidian/plugins/data-entry/manifest.json

@@ -0,0 +1 @@
+/home/wayne/code/obsidian-plugin-data-entry/packages/data-entry/manifest.json

.vault/.obsidian/workspace.json

@@ -11,8 +11,12 @@
             "id": "31fac1ab6a60f1aa",
             "type": "leaf",
             "state": {
-              "type": "empty",
-              "state": {}
+              "type": "markdown",
+              "state": {
+                "file": "Yello world.md",
+                "mode": "preview",
+                "source": true
+              }
             }
           }
         ]
@@ -81,6 +85,7 @@
             "state": {
               "type": "backlink",
               "state": {
+                "file": "Yello world.md",
                 "collapseAll": false,
                 "extraContext": false,
                 "sortOrder": "alphabetical",
@@ -97,6 +102,7 @@
             "state": {
               "type": "outgoing-link",
               "state": {
+                "file": "Yello world.md",
                 "linksCollapsed": false,
                 "unlinkedCollapsed": true
               }
@@ -118,7 +124,9 @@
             "type": "leaf",
             "state": {
               "type": "outline",
-              "state": {}
+              "state": {
+                "file": "Yello world.md"
+              }
             }
           }
         ],

packages/data-entry/__mocks__/obsidian.ts

@@ -0,0 +1 @@
+export * from '@waynevanson/obsidian-mocks';

packages/data-entry/package.json

@@ -34,6 +34,7 @@
     "jest-environment-jsdom": "^29.6.2",
     "jest-image-snapshot": "^6.2.0",
     "obsidian": "latest",
+    "@waynevanson/obsidian-mocks": "workspace:../obsidian-mocks",
     "semantic-release": "^21.0.7",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",

packages/data-entry/src/hooks/datasource/file.spec.ts

@@ -11,7 +11,9 @@ describe(useFile, () => {
     };
     const mocks = createMocks({
       vault: {
-        [file.path]: file.contents,
+        root: {
+          [file.path]: file.contents,
+        },
       },
     });
     const hooked = rtl.renderHook(() => useFile(mocks.vault, file.path));

packages/data-entry/src/test-utils/mocks.ts

@@ -1,22 +1,20 @@
 import { Theme } from '@mui/material';
 import { MainProps as ApplicationContext } from '../components';
-import { Vault } from 'obsidian';
-import { Directory } from '../../__mocks__/obsidian/vault/data-adapter';
+import { MockVaultParams, Vault, createVaultMock } from 'obsidian';
+import { Directory } from '@waynevanson/obsidian-mocks/dist/vault/data-adapter';
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface MockOptions {
   application?: Partial<Omit<ApplicationContext, 'vault'>> & {
     vault: Directory;
   };
 }
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface MockResult {
   vault: Vault;
 }
 
 export interface MockContextOptions {
-  vault: Directory;
+  vault?: MockVaultParams;
 }
 
 export interface MockContextResult {
@@ -25,6 +23,5 @@ export interface MockContextResult {
 }
 
 export const createMocks = (options?: MockContextOptions): MockResult => ({
-  //@ts-expect-error
-  vault: new Vault(options?.vault),
+  vault: createVaultMock(options?.vault ?? { root: {} }),
 });

packages/data-entry/src/test-utils/rtl.tsx

@@ -6,6 +6,7 @@ import { MockOptions, MockResult, createMocks } from './mocks';
 import { ThemeProvider, createTheme } from '@mui/material';
 import deepmerge from 'deepmerge';
 
+//todo-add types here
 export interface RenderOptions<
   Q extends rtl.Queries = typeof rtl.queries,
   Container extends Element | DocumentFragment = HTMLElement,
@@ -46,7 +47,7 @@ export function render<
     {} as never,
     options?.application ?? {},
   );
-  const mocks = createMocks({ vault: options?.application?.vault ?? {} });
+  const mocks = createMocks({ vault: { root: vaultOptions } });
   const application = { ...most, vault: mocks.vault };
 
   const wrapper: React.JSXElementConstructor<{

packages/obsidian-mocks/.gitignore

@@ -0,0 +1 @@
+/dist

packages/obsidian-mocks/package.json

@@ -1,3 +1,18 @@
 {
-  "name": "@waynevanson/obsidian-mocks"
+  "name": "@waynevanson/obsidian-mocks",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "scripts": {
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.3",
+    "@types/node": "^18.17.3",
+    "jest": "^29.6.2",
+    "obsidian": "^1.4.0",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "4.7.4"
+  }
 }

packages/data-entry/__mocks__/obsidian/vault/data-adapter.ts → packages/obsidian-mocks/src/data-adapter.ts

@@ -1,4 +1,4 @@
-import { DataAdapter } from 'obsidian';
+import type { DataAdapter } from 'obsidian';
 
 export type FileConstructorParams = string;
 
@@ -10,6 +10,8 @@ export interface Directory extends Record<string, Item> {}
 export function createDataAdapter(
   system: Directory,
 ): DataAdapter & { existsSync: (path: string) => boolean } {
+  // todo - add time
+  const now = Date.now();
   const cache: Record<string, string> = {};
   const split: Array<string> = [];
 

packages/data-entry/__mocks__/obsidian/events.ts → packages/obsidian-mocks/src/events.ts

@@ -13,7 +13,7 @@ export class Events {
     callback: (...data: Array<unknown>) => void,
     ctx?: unknown,
   ): EventRef {
-    const ref: EventRef = { name, callback };
+    const ref: EventRef = { mockName: name, mockCallback: callback };
 
     const handlers = this.handlersByName.has(name)
       ? this.handlersByName.get(name)!
@@ -34,7 +34,7 @@ export class Events {
   }
 
   offref(ref: EventRef): void {
-    this.off(ref.name, ref.callback);
+    this.off(ref.mockName, ref.mockCallback);
   }
 
   trigger(name: string, ...data: Array<unknown>): void {

packages/obsidian-mocks/src/index.ts

@@ -0,0 +1,18 @@
+export * from './events';
+export * from './vault';
+
+import 'obsidian';
+import { Directory } from './data-adapter';
+
+declare module 'obsidian' {
+  export interface EventRef {
+    mockName: string;
+    mockCallback: (...data: Array<unknown>) => void;
+  }
+
+  export interface MockVaultParams {
+    root: Directory;
+  }
+
+  export function createVaultMock(params: MockVaultParams): Vault;
+}

packages/obsidian-mocks/src/vault.ts

@@ -0,0 +1,78 @@
+import { Events } from './events';
+import { createDataAdapter } from './data-adapter';
+import type { DataAdapter, MockVaultParams } from 'obsidian';
+
+export function createVaultMock(params: MockVaultParams): Vault {
+  return new Vault(params);
+}
+
+export class Vault extends Events {
+  public adapter: ReturnType<typeof createDataAdapter> & DataAdapter;
+
+  constructor(params: MockVaultParams) {
+    super();
+    this.adapter = createDataAdapter(params.root);
+  }
+
+  getAbstractFileByPath(this: this, path: string): TAbstractFile | null {
+    const exists = this.adapter.existsSync(path);
+    if (!exists) return null;
+    else {
+      return new TFile({
+        name: path,
+        path,
+        vault: this,
+        parent: null,
+      });
+    }
+  }
+
+  async read(this: this, file: TFile) {
+    return this.adapter.read(file.path);
+  }
+}
+
+type Properties<T> = { [P in keyof T]: T[P] };
+
+export abstract class TAbstractFile {
+  vault!: Vault;
+  path!: string;
+  name!: string;
+  parent!: TFolder | null;
+
+  constructor(properties: Properties<TAbstractFile>) {
+    Object.assign(this, properties);
+  }
+}
+
+export class TFolder extends TAbstractFile {
+  children!: TAbstractFile[];
+
+  constructor(properties: Properties<TFolder>) {
+    super(properties);
+    Object.assign(this, properties);
+  }
+
+  isRoot(): boolean {
+    return this.parent == null;
+  }
+}
+
+export class TFile extends TAbstractFile {
+  constructor(properties: Properties<TFile>) {
+    super(properties);
+    Object.assign(this, properties);
+  }
+
+  // get basename(): string {
+  //   return '';
+  // }
+
+  // get stat(): FileStats {
+  //   return;
+  // }
+
+  // get extension(): string {
+  //   return;
+  // }
+}

packages/obsidian-mocks/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "target": "es6",
+    "strictNullChecks": true,
+    "outDir": "dist",
+    "declaration": true,
+    "esModuleInterop": true
+  },
+  "include": ["src"]
+}