new cli #79

hoshinotsuyoshi · 2024-11-08T00:57:57Z

Summary

This PR introduces a new CLI tool called liam that wraps Vite commands (build, dev, and preview). It includes a preprocessing feature for .sql files, converting them into a JSON format and saving them in the public directory.

Related Issue

N/A

Changes

Added liam CLI Tool:
- Created bin/cli.ts using commander for command-line interface functionality.
- Implemented runPreprocess function to read .sql files and convert them to schema.json in the public directory.
Sample SQL File:
- Added fixtures/input.sql as a sample input for CLI testing.
Updated .gitignore:
- Added dist-cli and public/schema.json to the ignore list.
Modified package.json:
- Added a bin entry for liam.
- Updated scripts to build and run the CLI tool.
- Included commander and @types/commander as dependencies.
Updated TypeScript Configurations:
- Enabled incremental builds and specified dist-cli as the output directory.
Changes to App.tsx:
- Added logic to fetch schema.json asynchronously and display the content in the UI.

7a6aa44 : $ pnpm add commander
5270bee : Update dependencies
27ba010 : Add 'incremental' option to avoid TS5111 error
f9c2de6 : Update tsconfig files to specify output directories
a6d8b88 : Implement initial CLI functionality and update package configuration
2ccf588 : Display file content in a <pre> tag for demo purposes in App.tsx
7bcd8d2 : Update README

Testing

1. Verifying CLI Functionality

# (cd to frontend/packages/cli)
# Clean up temporary directories for a fresh start
$ rm -rf dist dist-cli/ node_modules/.tmp

# Enable `liam` command.
$ pnpm run build:cli
$ pnpm link --global

$ cd (some other directory you like...)

$ echo 'brabra' > some.sql

$ liam erd build --input some.sql
# Outputs:
# - dist/
# - public/schema.json

$ liam erd preview

I confirmed that Preview server is running at http://localhost:4173 ✓

2. Verifying npm Scripts

# (cd to frontend/packages/cli)
# Clean up temporary directories for a fresh start
$ rm -rf dist dist-cli/ node_modules/.tmp
$ pnpm run build
# Outputs:
# - dist/
# - public/schema.json

$ pnpm run preview

I confirmed that Preview server is running at http://localhost:4173 ✓ .

(Note: Running $ pnpm run build will display the contents of fixtures/input.sql.)

$ pnpm run dev

I confirmed that Dev server is running at http://localhost:5173 ✓ .
HMR is worked ✓.

- `@types/node` for bin/cli.ts - move vite to dependencies from devDependencies

- Fixed TS5111 error: "Option 'tsBuildInfoFile' cannot be specified without specifying option 'incremental' or 'composite' or if not running 'tsc -b'." - Added `"incremental": true` to both `tsconfig.app.json` and `tsconfig.node.json` to ensure TypeScript incremental builds are enabled.

- Added `"outDir": "dist"` to `tsconfig.app.json` to define the output directory for compiled web application files. - Added `"outDir": "dist-cli"` and set `"noEmit": false` in `tsconfig.node.json` to enable emitting compiled files for the CLI. - Updated `tsconfig.node.json` to include `bin` in the `include` paths for TypeScript compilation.

- Added `liam-cli` implementation using `commander` to run `build`, `dev`, and `preview` commands. - Implemented SQL file preprocessing that converts `.sql` content to JSON and outputs it in the `public/schema.json`. - Configured Vite options in `bin/cli.ts` for building and previewing the web application. - Added `fixtures/input.sql` as a sample SQL file for testing. - Updated `.gitignore` to exclude `dist-cli` and `public/schema.json`. - Updated `package.json`: - Added `bin` configuration to expose `liam-cli`. - Defined npm scripts for building and running the CLI. - Added a placeholder `.keep` file in the `public` directory.

- Added state and useEffect hook to fetch and display `/schema.json` content. - Rendered the file content inside a styled <pre> tag for demonstration.

MH4GF

Thanks!!
I only check the README and commented on it!

frontend/packages/cli/README.md

MH4GF · 2024-11-08T08:04:38Z

frontend/packages/cli/README.md

Nice README! 😄

FunamaYukina

I followed the instructions in the README and was able to successfully test the build, dev, and preview commands, as well as the liam command in my local environment. 👍Thank you for your support!

frontend/packages/cli/bin/cli.ts

hoshinotsuyoshi · 2024-11-13T00:52:31Z

Resolved the conflict with #84 by aligning the changes made in this commit.

I've confirmed that everything mentioned under Testing is working as expected. ✅

frontend/packages/cli/.gitignore

Conflicts: frontend/packages/cli/.gitignore frontend/packages/cli/package.json frontend/pnpm-lock.yaml

hoshinotsuyoshi self-assigned this Nov 8, 2024

Base automatically changed from setup-erd-generator to main November 8, 2024 06:39

hoshinotsuyoshi force-pushed the setup-erd-generator-cli branch from 6cc80b1 to 34f516b Compare November 8, 2024 06:53

hoshinotsuyoshi added 7 commits November 8, 2024 16:31

$ pnpm add commander

7a6aa44

Update dependencies

5270bee

- `@types/node` for bin/cli.ts - move vite to dependencies from devDependencies

Display file content in a <pre> tag for demo purposes in App.tsx

2ccf588

- Added state and useEffect hook to fetch and display `/schema.json` content. - Rendered the file content inside a styled <pre> tag for demonstration.

Update README

7bcd8d2

hoshinotsuyoshi force-pushed the setup-erd-generator-cli branch from 34f516b to 7bcd8d2 Compare November 8, 2024 07:35

hoshinotsuyoshi marked this pull request as ready for review November 8, 2024 07:39

hoshinotsuyoshi requested a review from a team as a code owner November 8, 2024 07:39

hoshinotsuyoshi requested review from FunamaYukina, junkisai, MH4GF and sasamuku and removed request for a team November 8, 2024 07:39

MH4GF reviewed Nov 8, 2024

View reviewed changes

frontend/packages/cli/README.md Outdated Show resolved Hide resolved

frontend/packages/cli/README.md

Copy link

Member

MH4GF Nov 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice README! 😄

hoshinotsuyoshi added 2 commits November 8, 2024 17:18

Rename command name: liam-cli -> liam

8ccc65a

Change to subcommand liam erd

52e18ad

hoshinotsuyoshi requested a review from MH4GF November 11, 2024 08:34

hoshinotsuyoshi mentioned this pull request Nov 11, 2024

Enhance Frontend CI with Testing #81

Merged

FunamaYukina approved these changes Nov 12, 2024

View reviewed changes

frontend/packages/cli/bin/cli.ts Show resolved Hide resolved

hoshinotsuyoshi requested a review from a team as a code owner November 13, 2024 00:50

hoshinotsuyoshi commented Nov 13, 2024

View reviewed changes

frontend/packages/cli/.gitignore Outdated Show resolved Hide resolved

Merge branch 'main' into setup-erd-generator-cli

d10fbcc

Conflicts: frontend/packages/cli/.gitignore frontend/packages/cli/package.json frontend/pnpm-lock.yaml

hoshinotsuyoshi force-pushed the setup-erd-generator-cli branch from 1f9e8f7 to d10fbcc Compare November 13, 2024 00:54

hoshinotsuyoshi added this pull request to the merge queue Nov 13, 2024

Merged via the queue into main with commit e41f2a1 Nov 13, 2024
6 checks passed

hoshinotsuyoshi deleted the setup-erd-generator-cli branch November 13, 2024 05:20

hoshinotsuyoshi mentioned this pull request Nov 13, 2024

Convert DBStructure to React Flow nodes #86

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

new cli #79

new cli #79

hoshinotsuyoshi commented Nov 8, 2024 •

edited

Loading

MH4GF left a comment •

edited

Loading

MH4GF Nov 8, 2024

FunamaYukina left a comment •

edited

Loading

hoshinotsuyoshi commented Nov 13, 2024 •

edited

Loading

new cli #79

new cli #79

Conversation

hoshinotsuyoshi commented Nov 8, 2024 • edited Loading

Summary

Related Issue

Changes

Testing

1. Verifying CLI Functionality

2. Verifying npm Scripts

MH4GF left a comment • edited Loading

Choose a reason for hiding this comment

MH4GF Nov 8, 2024

Choose a reason for hiding this comment

FunamaYukina left a comment • edited Loading

Choose a reason for hiding this comment

hoshinotsuyoshi commented Nov 13, 2024 • edited Loading

hoshinotsuyoshi commented Nov 8, 2024 •

edited

Loading

MH4GF left a comment •

edited

Loading

FunamaYukina left a comment •

edited

Loading

hoshinotsuyoshi commented Nov 13, 2024 •

edited

Loading