Programmatic usage

[thdxr]

Looking for some examples for programmatic usage

[innocenzi]

If you can be more specific, I can help. Here is how to apply a preset programmatically:

import path from 'node:path'
import { applyPreset, emitter } from '@preset/core'

async function main() {
	emitter.on('action:start', (action) => {
		console.log(action.name, 'started')
	})

	emitter.on('preset:start', (preset) => {
		console.log(preset.name, 'is being applied')
	})

	emitter.on('preset:end', (preset) => {
		console.log('Preset finished:', preset)
	})

	await applyPreset({
		resolvable: 'innocenzi/config',
		parsedOptions: { ssh: false},
		rawArguments: ['--eslint'],
		targetDirectory: path.resolve('target'),
	})
}

main().catch(console.log)

As you can see, you can get data from what's happening through events.

[roni-estein]

I was at the time, running a long bash script to install laravel and configure tailwind vite and another number of items I don't really want to keep track of and do manually. But I've been playing with preset, for fun to try and move away from jq or other local installed elements in an effort to slightly simply installation and configuration. I got pretty far with the docs and a bit of source diving although my javascript is not as strong as it could be and my typescript is non-existant, but I like the "idea" of it. The biggest issues I've run are in the executeCommand interface, specifically on git. They might be a function of timing. Here is an example that blows up for me, granted I've added extra steps to make preset do everything including acting as an installer, just because I wanted to see how far I could take it.

    handler: async (context) => {

        if(context.options.install){
            await group({
                title: 'Install Laravel',
                handler: async () => {

                    await executeCommand({command: 'Laravel', arguments: ['new', context.options.appName]})
                    await executeCommand({command: 'git', arguments: ['-C', context.options.appName, 'init']})
                    await executeCommand({
                        command: 'git',
                        arguments: ['commit', '-C', context.options.appName, '-a', '-m', '"Fresh Laravel Install"']
                    })
                }
            })
        }else{

Basically each component or situation is if wrapped from the main handler. But right now this is the only one that is running to test the install. It will install laravel, and initialize and empty directory as the repository (no readme file oddly), but fail because the directory is not initialize or I've seen it fail because there is nothing to commit in other instances. I think becasue everything is async the git add _ commit is running before the install and init. Although in other places I have commands stacked in order and they do seem to work, for example making a bunch of changes or installing a package and then committing.

Here is the output:

VERSION MISMATCH

VERSION MISMATCH

VERSION MISMATCH

➜ Current version: v0.6.0 (latest)
➜ Preset laravel:preset-filament requires ^0.5.3 (outdated, may not work)

RUN Applying preset: laravel:preset-filament...

⠹ Running action: Install Laravel

VERSION MISMATCH

VERSION MISMATCH

➜ Current version: v0.6.0 (latest)
➜ Preset laravel:preset-filament requires ^0.5.3 (outdated, may not work)

ERR Failed applying: laravel:preset-filament.

× Failed action: Install Laravel (3 actions)
↪ Command failed with exit code 128: git commit -C fake-app -a -m "Fresh Laravel Install"
fatal: not a git repository (or any of the parent directories): .git
↪ Action group was not successful.

Presets 1 failed (1)
Actions 2 ran | 2 failed (4)
Time 6.57s

[innocenzi]

Hey. You should open another discussion since this one is not really related. Can you run your preset with --debug in order to have the complete log, so we can see why the repository is not initialized?

[roni-estein]

Yikes! I thought I had made a new discussion, I must have pasted it into the wrong markdown field! I'll paste it there along with the --debug output

[innocenzi]

Without testing it, I think it comes from -C. I'm not sure what you think it does, and I never used it, but it's this argument that makes the command throw.

That being said, you are going to have an issue if you use laravel new: it will create a new subdirectory, and there is no option to change that.

Preset has been designed to be used on an existing project that has just been created, not exactly to scaffold the project like you're trying to do. It may still be possible depending on the situation, but in this case it looks like a PR to execute-command will be needed to be able to change the working directory.

There are alternatives in your situation though:

1. Use laravel new's --git

await executeCommand({ command: 'laravel', arguments: ['new', context.options.appName, '--git', '--no-interaction'] })

2. Use composer create-project

This will install in the current working directory instead. But you can start the command with a subdirectory option: preset apply laravel:preset-filament my-preset-app

await executeCommand({ command: 'composer', arguments: ['create-project', 'laravel/laravel', '.'] })
await executeCommand({ command: 'git', arguments: ['init'] })
await executeCommand({ command: 'git', arguments: ['commit', '-am', '"chore: initialize laravel"'] })

I highly recommend the later solution, because Preset should be in the same working directory as its actions are started in. As an additional bonus, it doesn't require laravel/installer to be installed.

Side-note: update your preset version in package.json (use npx taze -w and npm i to do it properly). You won't get the version mismatch warning anymore after that.

[roni-estein]

nice! I'll try this now. Also git -C <folder> command lets you run git commands in another folder.