update base project locator

Author: softmarshmallow

cli/_utils/path/index.ts

@@ -1,21 +1,30 @@
 import fs from "fs";
 import path from "path";
-
+import glob from "glob";
 /**
  * finds file with name in cwd
  *
  * e.g. package.json -> <cwd>/package.json
+ * e.g. pubspec.y{,a}ml -> <cwd>/pubspec.yaml
  *
  * @param name
  * @param cwd
  * @returns
  */
-export function find_in_cwd(name, cwd = process.cwd()) {
-  const file = path.join(cwd, name);
-  if (fs.existsSync(file)) {
-    return file;
+export function find_in_cwd(name, cwd = process.cwd(), useglob = false) {
+  if (useglob) {
+    const file = glob.sync(name, { cwd }).pop() || null;
+    if (file) {
+      return path.resolve(cwd, file);
+    }
+  } else {
+    const file = path.join(cwd, name);
+
+    if (fs.existsSync(file)) {
+      return file;
+    }
+    return null;
   }
-  return null;
 }
 
 /**
@@ -26,17 +35,29 @@ export function find_in_cwd(name, cwd = process.cwd()) {
  * ../../../package.json
  * ...
  */
-export function find_in_parent(name, cwd = process.cwd(), recursively = true) {
+export function find_in_parent(
+  name,
+  cwd = process.cwd(),
+  recursively = true,
+  useglob = false
+) {
   const parent_dir = path.dirname(cwd);
   if (parent_dir === cwd) {
     return null;
   }
-  const file = path.join(parent_dir, name);
-  if (fs.existsSync(file)) {
-    return file;
+  if (useglob) {
+    const file = glob.sync(name, { cwd: parent_dir }).pop() || null;
+    if (file) {
+      return path.join(parent_dir, file);
+    }
+  } else {
+    const file = path.join(parent_dir, name);
+    if (fs.existsSync(file)) {
+      return file;
+    }
   }
   if (recursively) {
-    return find_in_parent(name, parent_dir, recursively);
+    return find_in_parent(name, parent_dir, recursively, useglob);
   }
   return null;
 }

cli/npm/index.ts

@@ -7,7 +7,7 @@ const _PACKAGE_JSON = "package.json";
 /**
  * finds a npm pacakge root with package.json search
  */
-export function locatePackage(cwd = process.cwd()): {
+export function locateNodePackage(cwd = process.cwd()): {
   base_dir: string;
   package_json: string;
   manifest: IPackageManifest;
@@ -39,3 +39,62 @@ export function locatePackage(cwd = process.cwd()): {
 export function read(path): IPackageManifest {
   return require(path);
 }
+
+export function analyzeFramework(manifest: IPackageManifest): {
+  framework: "react" | "react-native" | "solid-js" | "svelte" | "vue";
+  packages?: string[];
+} {
+  const deps = new Set(Object.keys(manifest.dependencies || {}));
+  const devdeps = new Set(Object.keys(manifest.devDependencies || {}));
+  const alldeps = new Set([...deps, ...devdeps]);
+
+  // framework
+  const isreact = alldeps.has("react");
+  const isreactnative = alldeps.has("react-native");
+  const isvue3 = alldeps.has("vue");
+  const issvelte = alldeps.has("svelte");
+  const issolidjs = alldeps.has("solid-js");
+
+  // managed packages
+  const namedpackages = [
+    "styled-components",
+    "@emotion/styled",
+    "@emotion/native",
+  ];
+
+  const packages = namedpackages
+    .map((k) => {
+      if (alldeps.has(k)) {
+        return k;
+      }
+    })
+    .filter(Boolean);
+
+  if (isreact) {
+    if (isreactnative) {
+      return { framework: "react-native", packages: packages };
+    }
+    return { framework: "react", packages: packages };
+  }
+
+  if (isvue3) {
+    return {
+      framework: "vue",
+      packages: packages,
+    };
+  }
+
+  if (issvelte) {
+    return {
+      framework: "svelte",
+      packages: packages,
+    };
+  }
+
+  if (issolidjs) {
+    return {
+      framework: "solid-js",
+      packages: packages,
+    };
+  }
+}

cli/project/__test__/find-project.test.ts

@@ -1,25 +1,25 @@
-import { locateProject, read } from "../index";
+import { locateGridaProject, read } from "../index";
 import path from "path";
 
 test("find grida project cwd", () => {
-  const _ = locateProject(__dirname);
+  const _ = locateGridaProject(__dirname);
   expect(_?.config_file).toBe(path.join(__dirname, "grida.config.js"));
 });
 
 test("find grida project from subdir", () => {
-  const _ = locateProject(path.join(__dirname, "sub-dir-for-testing"));
+  const _ = locateGridaProject(path.join(__dirname, "sub-dir-for-testing"));
   expect(_?.config_file).toBe(path.join(__dirname, "grida.config.js"));
 });
 
 test("find grida project from subdir (deep)", () => {
-  const _ = locateProject(
+  const _ = locateGridaProject(
     path.join(__dirname, "sub-dir-for-testing", "another-nested-dir")
   );
   expect(_?.config_file).toBe(path.join(__dirname, "grida.config.js"));
 });
 
 test("read config", () => {
-  const _ = locateProject(
+  const _ = locateGridaProject(
     path.join(__dirname, "sub-dir-for-testing", "another-nested-dir")
   );
   expect(read(_?.config_file).name).toBe("__test__");

cli/project/index.ts

@@ -1,5 +1,10 @@
-import { BuilderConfig } from "@grida/builder-config";
+import { BuilderConfig, FrameworkConfig } from "@grida/builder-config";
 import path from "path";
+import {
+  analyzeFramework as analyzeJsFramework,
+  locateNodePackage,
+} from "../npm";
+import { analyzeFramework as analyzePubFramework, locatePubspec } from "../pub";
 import { find_in_cwd, find_in_parent } from "../_utils/path";
 
 const _GRIDA_CONFIG_JS = "grida.config.js";
@@ -24,7 +29,7 @@ export function read(path): BuilderConfig {
  * @param cwd
  * @returns
  */
-export function locateProject(
+export function locateGridaProject(
   cwd = process.cwd()
 ): GridaProjectSearchResult | null {
   const grida_config_js = find_in_cwd(_GRIDA_CONFIG_JS, cwd);
@@ -49,3 +54,50 @@ export function locateProject(
   }
   return null;
 }
+
+export function locateBaseProject(cwd = process.cwd()): {
+  base_dir: string;
+  name: string;
+  config_file: string;
+  framework: FrameworkConfig["framework"];
+  packages?: string[];
+} {
+  const pubspec = locatePubspec(cwd);
+  const npm = locateNodePackage(cwd);
+
+  if (npm && pubspec) {
+    throw new Error(
+      `Invalid project root configuration. both pubspec.yaml and package.json found from ${cwd}`
+    );
+  }
+
+  if (npm) {
+    const res = analyzeJsFramework(npm.manifest);
+    if (res) {
+      if (res.framework === "vue") {
+        throw new Error("Vue is not supported yet");
+      }
+      if (res.framework === "svelte") {
+        throw new Error("Svelte is not supported yet");
+      }
+      return {
+        base_dir: npm.base_dir,
+        name: npm.manifest.name,
+        config_file: npm.package_json,
+        ...(res as any),
+      };
+    }
+  }
+
+  if (pubspec) {
+    const res = analyzePubFramework(pubspec.manifest);
+    if (res) {
+      return {
+        base_dir: pubspec.base_dir,
+        name: pubspec.manifest.name,
+        config_file: pubspec.pubspec_yaml,
+        ...res,
+      };
+    }
+  }
+}

cli/pub/__test__/find-pubspec-yaml.test.ts

@@ -0,0 +1,6 @@
+import { locatePubspec } from "../index";
+import path from "path";
+test("find grida project cwd", () => {
+  const _ = locatePubspec(path.join(__dirname, "sub-dir-for-testing"));
+  expect(_.manifest.name).toBe("pubtest");
+});

cli/pub/__test__/pubspec.yaml

@@ -0,0 +1 @@
+name: pubtest

cli/pub/__test__/sub-dir-for-testing/.gitkeep

@@ -1 +1,56 @@
-export function findPubSpec() {}
+import path from "path";
+import { find_in_cwd, find_in_parent } from "../_utils/path";
+import YAML from "yaml";
+import fs from "fs";
+
+const _PUBSPEC_YAML = "pubspec.y{,a}ml";
+
+interface IPubSpecManifest {
+  name: string;
+  description?: string;
+  dependencies?: { [key: string]: string };
+}
+
+interface PubspecSearchResult {
+  base_dir: string;
+  pubspec_yaml: string;
+  manifest: IPubSpecManifest;
+}
+
+export function locatePubspec(cwd = process.cwd()): PubspecSearchResult | null {
+  const pubspecyaml = find_in_cwd(_PUBSPEC_YAML, cwd, true);
+  if (pubspecyaml) {
+    return {
+      base_dir: path.dirname(pubspecyaml),
+      pubspec_yaml: pubspecyaml,
+      manifest: read(pubspecyaml),
+    };
+  }
+  const pubspecyaml_in_parent_dir = find_in_parent(
+    _PUBSPEC_YAML,
+    cwd,
+    true,
+    true
+  );
+  if (pubspecyaml_in_parent_dir) {
+    return {
+      base_dir: path.dirname(pubspecyaml_in_parent_dir),
+      pubspec_yaml: pubspecyaml_in_parent_dir,
+      manifest: read(path.join(pubspecyaml_in_parent_dir)),
+    };
+  }
+  return null;
+}
+
+export function read(pubspec: string): IPubSpecManifest {
+  return YAML.parse(fs.readFileSync(pubspec, "utf8"));
+}
+
+export function analyzeFramework(pubspec: IPubSpecManifest): {
+  framework: "flutter";
+} {
+  const isflutter = "flutter" in pubspec || pubspec.dependencies?.flutter;
+  if (isflutter) {
+    return { framework: "flutter" };
+  }
+}