-
Notifications
You must be signed in to change notification settings - Fork 0
Improve onboarding with automatic detection and suggestions #26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,31 @@ | ||
| import assert from "node:assert/strict"; | ||
| import { mkdirSync, mkdtempSync, writeFileSync } from "node:fs"; | ||
| import { tmpdir } from "node:os"; | ||
| import { join } from "node:path"; | ||
| import { describe, it } from "node:test"; | ||
| import { detectSetup } from "@sourcedraft/setup"; | ||
| import { generateConfigFromDetection } from "@sourcedraft/setup"; | ||
|
|
||
| describe("generate config from detection", () => { | ||
| it("creates config for an Astro sample project", () => { | ||
| const root = mkdtempSync(join(tmpdir(), "api-generate-config-")); | ||
| writeFileSync(join(root, "astro.config.mjs"), "export default {};\n", "utf8"); | ||
| writeFileSync( | ||
| join(root, "package.json"), | ||
| JSON.stringify({ dependencies: { astro: "^5.0.0" } }), | ||
| "utf8", | ||
| ); | ||
| mkdirSync(join(root, "src/content/blog"), { recursive: true }); | ||
| writeFileSync(join(root, "src/content/blog/post.mdx"), "---\ntitle: Hi\n---\n", "utf8"); | ||
|
|
||
| const detection = detectSetup(root); | ||
| const result = generateConfigFromDetection(root, detection.primary); | ||
| assert.equal(result.ok, true); | ||
| if (!result.ok) { | ||
| return; | ||
| } | ||
|
|
||
| assert.match(result.summary, /adapter: astro-mdx/u); | ||
| assert.match(result.summary, /contentDir: src\/content\/blog/u); | ||
| }); | ||
| }); |
This file contains hidden or 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,39 @@ | ||
| import { resolve } from "node:path"; | ||
| import { generateConfigFromDetection } from "@sourcedraft/setup"; | ||
| import { resolveSetupDetectionRoot, runSetupDetection } from "./setupDetection.js"; | ||
|
|
||
| export type GenerateConfigResponse = | ||
| | { | ||
| ok: true; | ||
| configPath: string; | ||
| summary: string; | ||
| } | ||
| | { | ||
| ok: false; | ||
| code: string; | ||
| error: string; | ||
| }; | ||
|
|
||
| export function runGenerateConfig(): GenerateConfigResponse { | ||
| const detection = runSetupDetection(); | ||
| const root = resolveSetupDetectionRoot(); | ||
| const result = generateConfigFromDetection(root, detection.primary); | ||
|
|
||
| if (!result.ok) { | ||
| return { | ||
| ok: false, | ||
| code: result.code, | ||
| error: result.error, | ||
| }; | ||
| } | ||
|
|
||
| return { | ||
| ok: true, | ||
| configPath: result.configPath, | ||
| summary: result.summary, | ||
| }; | ||
| } | ||
|
|
||
| export function resolveGeneratedConfigPath(): string { | ||
| return resolve(resolveSetupDetectionRoot(), "sourcedraft.config.json"); | ||
| } | ||
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When the API is started from
apps/studio(the normal package script cwd),resolveSetupDetectionRoot()stops at that package'spackage.json, so this writesapps/studio/sourcedraft.config.jsonrather than the project/root config thatloadSourceDraftConfig()would otherwise find in a parent directory. Because app-local config is loaded first, clicking Generate config can silently shadow an existing root config and make Studio switch to the newly detected/wrong paths.Useful? React with 👍 / 👎.