-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
double-click to open / open from cli (#3643)
* fixes Signed-off-by: Jess Frazelle <[email protected]> * add tests Signed-off-by: Jess Frazelle <[email protected]> * updates Signed-off-by: Jess Frazelle <[email protected]> * Look at this (photo)Graph *in the voice of Nickelback* * remove unneeded rust Signed-off-by: Jess Frazelle <[email protected]> * remove dep on clap Signed-off-by: Jess Frazelle <[email protected]> * fixups for imports Signed-off-by: Jess Frazelle <[email protected]> * updates Signed-off-by: Jess Frazelle <[email protected]> * fix types Signed-off-by: Jess Frazelle <[email protected]> * bump Signed-off-by: Jess Frazelle <[email protected]> --------- Signed-off-by: Jess Frazelle <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
fbf0d3d
commit 590a647
Showing
31 changed files
with
415 additions
and
1,540 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| import { promises as fs } from 'fs' | ||
| import path from 'path' | ||
| import os from 'os' | ||
| import { v4 as uuidv4 } from 'uuid' | ||
| import getCurrentProjectFile from './getCurrentProjectFile' | ||
|
|
||
| describe('getCurrentProjectFile', () => { | ||
| test('with explicit open file with space (URL encoded)', async () => { | ||
| const name = `kittycad-modeling-projects-${uuidv4()}` | ||
| const tmpProjectDir = path.join(os.tmpdir(), name) | ||
|
|
||
| await fs.mkdir(tmpProjectDir, { recursive: true }) | ||
| await fs.writeFile(path.join(tmpProjectDir, 'i have a space.kcl'), '') | ||
|
|
||
| const state = await getCurrentProjectFile( | ||
| path.join(tmpProjectDir, 'i%20have%20a%20space.kcl') | ||
| ) | ||
|
|
||
| expect(state).toBe(path.join(tmpProjectDir, 'i have a space.kcl')) | ||
|
|
||
| await fs.rm(tmpProjectDir, { recursive: true, force: true }) | ||
| }) | ||
|
|
||
| test('with explicit open file with space', async () => { | ||
| const name = `kittycad-modeling-projects-${uuidv4()}` | ||
| const tmpProjectDir = path.join(os.tmpdir(), name) | ||
|
|
||
| await fs.mkdir(tmpProjectDir, { recursive: true }) | ||
| await fs.writeFile(path.join(tmpProjectDir, 'i have a space.kcl'), '') | ||
|
|
||
| const state = await getCurrentProjectFile( | ||
| path.join(tmpProjectDir, 'i have a space.kcl') | ||
| ) | ||
|
|
||
| expect(state).toBe(path.join(tmpProjectDir, 'i have a space.kcl')) | ||
|
|
||
| await fs.rm(tmpProjectDir, { recursive: true, force: true }) | ||
| }) | ||
|
|
||
| test('with source path dot', async () => { | ||
| const name = `kittycad-modeling-projects-${uuidv4()}` | ||
| const tmpProjectDir = path.join(os.tmpdir(), name) | ||
| await fs.mkdir(tmpProjectDir, { recursive: true }) | ||
|
|
||
| // Set the current directory to the temp project directory. | ||
| const originalCwd = process.cwd() | ||
| process.chdir(tmpProjectDir) | ||
|
|
||
| try { | ||
| const state = await getCurrentProjectFile('.') | ||
|
|
||
| if (state instanceof Error) { | ||
| throw state | ||
| } | ||
|
|
||
| expect(state.replace('/private', '')).toBe( | ||
| path.join(tmpProjectDir, 'main.kcl') | ||
| ) | ||
| } finally { | ||
| process.chdir(originalCwd) | ||
| await fs.rm(tmpProjectDir, { recursive: true, force: true }) | ||
| } | ||
| }) | ||
|
|
||
| test('with main.kcl not existing', async () => { | ||
| const name = `kittycad-modeling-projects-${uuidv4()}` | ||
| const tmpProjectDir = path.join(os.tmpdir(), name) | ||
| await fs.mkdir(tmpProjectDir, { recursive: true }) | ||
|
|
||
| try { | ||
| const state = await getCurrentProjectFile(tmpProjectDir) | ||
|
|
||
| expect(state).toBe(path.join(tmpProjectDir, 'main.kcl')) | ||
| } finally { | ||
| await fs.rm(tmpProjectDir, { recursive: true, force: true }) | ||
| } | ||
| }) | ||
|
|
||
| test('with directory, main.kcl not existing, other.kcl does', async () => { | ||
| const name = `kittycad-modeling-projects-${uuidv4()}` | ||
| const tmpProjectDir = path.join(os.tmpdir(), name) | ||
| await fs.mkdir(tmpProjectDir, { recursive: true }) | ||
| await fs.writeFile(path.join(tmpProjectDir, 'other.kcl'), '') | ||
|
|
||
| try { | ||
| const state = await getCurrentProjectFile(tmpProjectDir) | ||
|
|
||
| expect(state).toBe(path.join(tmpProjectDir, 'other.kcl')) | ||
|
|
||
| // make sure we didn't create a main.kcl file | ||
| await expect( | ||
| fs.access(path.join(tmpProjectDir, 'main.kcl')) | ||
| ).rejects.toThrow() | ||
| } finally { | ||
| await fs.rm(tmpProjectDir, { recursive: true, force: true }) | ||
| } | ||
| }) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import * as path from 'path' | ||
| import * as fs from 'fs/promises' | ||
| import { Models } from '@kittycad/lib/dist/types/src' | ||
| import { PROJECT_ENTRYPOINT } from './constants' | ||
|
|
||
| // Create a const object with the values | ||
| const FILE_IMPORT_FORMATS = { | ||
| fbx: 'fbx', | ||
| gltf: 'gltf', | ||
| obj: 'obj', | ||
| ply: 'ply', | ||
| sldprt: 'sldprt', | ||
| step: 'step', | ||
| stl: 'stl', | ||
| } as const | ||
|
|
||
| // Extract the values into an array | ||
| const fileImportFormats: Models['FileImportFormat_type'][] = | ||
| Object.values(FILE_IMPORT_FORMATS) | ||
| export const allFileImportFormats: string[] = [ | ||
| ...fileImportFormats, | ||
| 'stp', | ||
| 'fbxb', | ||
| 'glb', | ||
| ] | ||
| export const relevantExtensions = ['kcl', ...allFileImportFormats] | ||
|
|
||
| /// Get the current project file from the path. | ||
| /// This is used for double-clicking on a file in the file explorer, | ||
| /// or the command line args, or deep linking. | ||
| export default async function getCurrentProjectFile( | ||
| pathString: string | ||
| ): Promise<string | Error> { | ||
| // Fix for "." path, which is the current directory. | ||
| let sourcePath = pathString === '.' ? process.cwd() : pathString | ||
|
|
||
| // URL decode the path. | ||
| sourcePath = decodeURIComponent(sourcePath) | ||
|
|
||
| // If the path does not start with a slash, it is a relative path. | ||
| // We need to convert it to an absolute path. | ||
| sourcePath = path.isAbsolute(sourcePath) | ||
| ? sourcePath | ||
| : path.join(process.cwd(), sourcePath) | ||
|
|
||
| // If the path is a directory, let's assume it is a project directory. | ||
| const stats = await fs.stat(sourcePath) | ||
| if (stats.isDirectory()) { | ||
| // Walk the directory and look for a kcl file. | ||
| const files = await fs.readdir(sourcePath) | ||
| const kclFiles = files.filter((file) => path.extname(file) === '.kcl') | ||
|
|
||
| if (kclFiles.length === 0) { | ||
| let projectFile = path.join(sourcePath, PROJECT_ENTRYPOINT) | ||
| // Check if we have a main.kcl file in the project. | ||
| try { | ||
| await fs.access(projectFile) | ||
| } catch { | ||
| // Create the default file in the project. | ||
| await fs.writeFile(projectFile, '') | ||
| } | ||
|
|
||
| return projectFile | ||
| } | ||
|
|
||
| // If a project entrypoint file exists, use it. | ||
| // Otherwise, use the first kcl file in the project. | ||
| const gotMain = files.filter((file) => file === PROJECT_ENTRYPOINT) | ||
| if (gotMain.length === 0) { | ||
| return path.join(sourcePath, kclFiles[0]) | ||
| } | ||
| return path.join(sourcePath, PROJECT_ENTRYPOINT) | ||
| } | ||
|
|
||
| // Check if the extension on what we are trying to open is a relevant file type. | ||
| const extension = path.extname(sourcePath).slice(1) | ||
|
|
||
| if (!relevantExtensions.includes(extension) && extension !== 'toml') { | ||
| return new Error( | ||
| `File type (${extension}) cannot be opened with this app: '${sourcePath}', try opening one of the following file types: ${relevantExtensions.join( | ||
| ', ' | ||
| )}` | ||
| ) | ||
| } | ||
|
|
||
| // We were given a file path, not a directory. | ||
| // Let's get the parent directory of the file. | ||
| const parent = path.dirname(sourcePath) | ||
|
|
||
| // If we got an import model file, we need to check if we have a file in the project for | ||
| // this import model. | ||
| if (allFileImportFormats.includes(extension)) { | ||
| const importFileName = path.basename(sourcePath) | ||
| // Check if we have a file in the project for this import model. | ||
| const kclWrapperFilename = `${importFileName}.kcl` | ||
| const kclWrapperFilePath = path.join(parent, kclWrapperFilename) | ||
|
|
||
| try { | ||
| await fs.access(kclWrapperFilePath) | ||
| } catch { | ||
| // Create the file in the project with the default import content. | ||
| const content = `// This file was automatically generated by the application when you | ||
| // double-clicked on the model file. | ||
| // You can edit this file to add your own content. | ||
| // But we recommend you keep the import statement as it is. | ||
| // For more information on the import statement, see the documentation at: | ||
| // https://zoo.dev/docs/kcl/import | ||
| const model = import("${importFileName}")` | ||
| await fs.writeFile(kclWrapperFilePath, content) | ||
| } | ||
|
|
||
| return kclWrapperFilePath | ||
| } | ||
|
|
||
| return sourcePath | ||
| } |
Oops, something went wrong.