feat: v1 implementation of create-permissionless-app CLI
#96
Conversation
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
Add a new CLI module located at `src/cli/index.ts` to encapsulate all CLI-related functionality. This module includes prompts for project configuration, bundler, paymaster, signer, and account system selection. Additionally, it provides the `runCli` function for handling CLI interactions. This commit includes some new files, mainly: - `src/cli/index.ts` - `src/utils/validateAppName.ts` - `src/utils/general.ts` - `src/constants.ts` - `src/utils/logger.ts`
This commit adds new modules and functionality for scaffolding our Permissionless applications and selecting boilerplate files based on user input. ### Notable changes: #### `selectBoilerplate.ts`: - Introduces the `selectBoilerplate` function to handle the selection of boilerplate files. - Defines helper functions for copying files and overwriting file content. - Accesses the base & extras dir and selects specific files based on bundler, paymaster, signer, and account system. #### `scaffoldProject.ts`: - Implements the `scaffoldProject` function for bootstrapping the base Permissionless application. - Provides options to clear the directory, overwrite conflicting files, or abort installation based on existing directory status. - Copies the entire `template/base` directory to the target directory and displays appropriate success or error messages. #### `createProject.ts`: - Defines the `createProject` function for orchestrating the entire project creation process. - Calls `scaffoldProject` to bootstrap the base application and `selectBoilerplate` to choose boilerplate based on user options. - Returns the project directory path. #### `src/index.ts`: - Integrates the new modules into the main CLI script. - Extracts user preferences from CLI input using `runCli` and invokes `createProject` with the selected options. - Writes the project name to the `package.json` file. Known issue: There are a couple of bugs in the first attempt of the `selectBoilerplate` method, which need further investigation and correction.
This commit adds a template directory that serves as a foundational structure for the generated Permissionless app, providing a starting point for development.
**base:** This directory contains the common essential files and structure for the final boilerplate.
- **extras:** This directory extends the base functionality by providing boilerplate configurations for specific choices, such as:
- Bundler configurations (`bundler` directory), e.g., 'pimlico'.
- Paymaster configurations (`paymaster` directory), e.g., 'pimlico'.
- Signer configurations (`signers` directory), e.g., 'privy'.
- Signer-specific hooks (`hooks` directory) for different account systems.
- Signer-specific components (`components` directory), e.g., 'PrivyAuth'.
- Additional page content for specific signers (`pages` directory), e.g., '_app/with-privy.tsx', 'index/with-privy.tsx'.
|
…ate setup this commit introduces enhancements to the `selectBoilerplate.ts` file, focusing on the methods responsible for file selection and setup. The modifications include: - fixed the file path resolution & implemented robust error handling mechanisms in the all these methods: `selectBundlerConfigFile`, `selectPaymasterConfigFile`, `selectSignerConfigFile`, `selectAppFile`, `selectIndexFile`, and `selectSignerHooks`. - added detailed logging to provide clear information in case of missing files or unsuccessful file copying.
…r utility Added two new functions to enhance the project setup process: - `installDependencies`: A standalone helper function to install project dependencies based on the detected package manager (npm, yarn, pnpm, bun). - `detectPackageManager`: A utility function to detect the package manager being used in the current environment. These additions improve the user experience by automatically handling dependency installation using the appropriate package manager and providing flexibility in supporting multiple package managers.
plusminushalf
requested changes
Feb 9, 2024
| # Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore | ||
|
|
||
| # Logs | ||
|
|
There was a problem hiding this comment.
Can you add these to the global .gitignore
| accountSystem: () => { | ||
| return p.select({ | ||
| message: "Pick your account system", | ||
| options: [{ value: "safe", label: "Safe" }], |
There was a problem hiding this comment.
I see you have simple account & kernel as well right?
There was a problem hiding this comment.
yep we have, was gonna add support for them later.. i ignored them since Kristof wanted to just have Safe for the v1 launch..
| // Stop spinner and notify users | ||
| spinner.succeed(chalk.green("Dependencies installed successfully.")) | ||
| } catch (error) { | ||
| console.error( |
There was a problem hiding this comment.
Hey I saw you have a logger class, I think we can replace such console logs with it.
There was a problem hiding this comment.
right right, missed this in an hurry..
|
|
||
| // If the first part is a @, it's a scoped package | ||
| const indexOfDelimiter = paths.findIndex((p) => p.startsWith("@")) | ||
| if (paths.findIndex((p) => p.startsWith("@")) !== -1) { |
There was a problem hiding this comment.
You can use indexOfDelimiter !== -1
There was a problem hiding this comment.
silly of me, yeah will replace it..
| return ( | ||
| <div className="z-10 max-w-5xl w-full items-center justify-between font-mono text-sm lg:flex"> | ||
| <p className="fixed left-0 top-0 flex flex-col w-full justify-center border-b border-gray-300 bg-gradient-to-b from-zinc-200 pb-6 pt-8 backdrop-blur-2xl dark:border-neutral-800 dark:bg-zinc-800/30 dark:from-inherit lg:static lg:w-auto lg:rounded-xl lg:border lg:bg-gray-200 lg:p-4 lg:dark:bg-zinc-800/30"> | ||
| Get started by cloning |
There was a problem hiding this comment.
I think we might want to change this, as this template shouldn't need to clone anything.
There was a problem hiding this comment.
yeah sure.. i just copied the template code from one of our starter kit & forgot to replace it..
| import { sepolia } from "wagmi" | ||
|
|
||
| export const createSafeAccount = async (publicClient: PublicClient) => { | ||
| const safeAccount: SafeSmartAccount = await privateKeyToSafeSmartAccount( |
There was a problem hiding this comment.
we are creating safe account but the directory is called simple
| import { goerli } from "viem/chains" | ||
|
|
||
| export const bundlerClient = createPimlicoBundlerClient({ | ||
| chain: goerli, |
There was a problem hiding this comment.
wagmi config is with sepolia, we might want to change this to sepolia too.
Also we can use transport as:
https://api.pimlico.io/v1/sepolia/rpc?apikey=API_KEY
|
Also can you take a pull and redo |
- rename the module from `bundlerClient` to `pimlicoBundlerConfig` - rename the module from `pimlicoPaymaster ` to `pimlicoPaymasterConfig ` - use `NEXT_PUBLIC_PIMLICO_BUNDLER_RPC_HOST` env instead of directly passing the rpc host
This commit adds a new utility function called 'updateIndexFile' to dynamically update/create the index.ts files in the target directory. The function ensures that import & export statements are correctly appended to the index.ts files whenever new files are copied based on the selected options.
Changes: - Introduced `runInstallCommand` function for executing package manager install commands with spinner animations. - Refactored `installDependencies` function to orchestrate the installation process, including directory handling, package manager detection, and error logging. - Improved error handling and logging messages for better user feedback.
- replaced console.log statements with Ora spinner messages for better user feedback during boilerplate setup - utilized chalk for colored and formatted success and failure messages - removed unnecessary console logs
This commit introduces a new feature to the CLI module in `src/cli/index.ts`. Specifically, it adds a new interactive prompt that allows users to confirm whether they want the CLI to run the package manager's install command. It also adds new CLI flags: - `--noInstall`: Allows users to explicitly skip running the package manager's install command. - `-y, --default`: Offers an option to bypass the CLI and utilize default settings for bootstrapping a new permissionless app.
- Added informative next steps for users after CLI execution. - Included some thank you note and apology message for beta issues. - Added a Telegram invitation link for users for feedback & potential issues.
add permissionless-app-v1
- ensure that newly created index files include the new module in the export statement. - fix the issue where the export statement was appending the new module multiple times in existing index files. - corrected the positioning of the export statement to be at the end of the file in both new and existing index files. - updated the `updateIndexFile` function to correctly handle both scenarios: creating new index files and updating existing ones. - implemented a check to prevent adding the new module to the export statement multiple times if it already exists. - tested the changes to ensure correct behavior in both cases of creating new index files and updating existing ones.
SouravInsights
force-pushed
the
create-permissionless-app-v1
branch
from
099656b
to
726156f
Compare
functionality to dynamically generate a .env file based on user-provided environment variables, ensuring proper configuration for the project.
mouseless0x
reviewed
Apr 1, 2024
packages/create-permissionless-app/template/base/src/components/Footer.tsx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Could we add a few lines/replace this default next.js README with a README specific to the create-permissionless-app template?
|
hey, @mouseless-eth resolved most of the issues! |
Added several utility functions to enhance Git-related operations in the CLI template generator tool: 1. `isGitInstalled`: - Checks if Git is installed by executing `git --version`. - Returns a boolean indicating the installation status of Git. 2. `isRootGitRepo`: - Determines if the specified directory contains a `.git` subdirectory. - Returns a boolean indicating the presence of a `.git` directory. 3. `isInsideGitRepo`: - Checks if the current directory or any parent directory contains a `.git` directory. - Executes `git rev-parse --is-inside-work-tree` to determine if within a Git repo. - Returns a boolean indicating whether a `.git` directory was found. 4. `getGitVersion`: - Retrieves the installed Git version by executing `git --version`. - Parses and returns the major and minor version numbers. 5. `getDefaultBranch`: - Returns the Git config value of `init.defaultBranch`. - Defaults to "main" if `init.defaultBranch` is not set. 6. `initializeGit`: - Initializes a Git repository in the specified directory. - Checks for existing Git installations and configurations. - Provides options to overwrite existing Git history or initialize a new repo within an existing worktree. - Uses the appropriate Git commands based on the Git version to initialize the repo and set the default branch. Enhanced user experience by adding prompts and warnings for operations that might affect existing Git repositories. Utilized `execa` for executing shell commands, `fs-extra` for file system operations, and `ora` for spinner animations to provide feedback during the initialization process. Logging and error handling have been integrated to ensure smooth operations and clear user communication.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces the v1 implementation of our
create-permissionless-appCLI.Commits Overview:
How to run the cli app: