From addd67d2445de7bf61124412347b050b9a2d2caa Mon Sep 17 00:00:00 2001 From: Drew Powers <1369770+drwpow@users.noreply.github.com> Date: Tue, 1 Jun 2021 09:57:12 -0600 Subject: [PATCH] Change astroRoot to pages (#277) #271 --- .changeset/sour-students-remain.md | 5 +++ docs/config.md | 4 +- examples/blog/astro.config.mjs | 2 +- examples/snowpack/astro.config.mjs | 2 +- packages/astro/src/@types/astro.ts | 4 +- packages/astro/src/build.ts | 5 +-- packages/astro/src/build/page.ts | 10 ++--- packages/astro/src/build/util.ts | 38 +++++++++++++------ packages/astro/src/compiler/codegen/index.ts | 3 +- .../src/compiler/transform/module-scripts.ts | 5 +-- packages/astro/src/config.ts | 6 +-- packages/astro/src/runtime.ts | 14 +++---- packages/astro/src/search.ts | 20 +++++----- packages/astro/test/astro-markdown.test.js | 4 +- packages/astro/test/astro-styles-ssr.test.js | 12 +++--- .../src/templates/blog/astro.config.mjs | 2 +- .../src/templates/starter/astro.config.mjs | 2 +- 17 files changed, 76 insertions(+), 62 deletions(-) create mode 100644 .changeset/sour-students-remain.md diff --git a/.changeset/sour-students-remain.md b/.changeset/sour-students-remain.md new file mode 100644 index 0000000000..2cc82193c8 --- /dev/null +++ b/.changeset/sour-students-remain.md @@ -0,0 +1,5 @@ +--- +'astro': patch +--- + +Rename `astroConfig` to `pages` in config. Docs updated. diff --git a/docs/config.md b/docs/config.md index 1dffbc49a9..7474109ccf 100644 --- a/docs/config.md +++ b/docs/config.md @@ -6,8 +6,8 @@ To configure Astro, add an `astro.config.mjs` file in the root of your project. export default { /** Where to resolve all URLs relative to. Useful if you have a monorepo project. */ projectRoot: '.', - /** Path to Astro components, pages, and data */ - astroRoot: './src', + /** Path to your site’s pages (routes) */ + pages: './src/pages', /** When running `astro build`, path to final static output */ dist: './dist', /** A folder of static files Astro will copy to the root. Useful for favicons, images, and other files that don’t need processing. */ diff --git a/examples/blog/astro.config.mjs b/examples/blog/astro.config.mjs index 89416b20f0..9933e95711 100644 --- a/examples/blog/astro.config.mjs +++ b/examples/blog/astro.config.mjs @@ -1,10 +1,10 @@ export default { projectRoot: '.', + pages: './src/pages', public: './public', dist: './dist', buildOptions: { sitemap: true, site: 'https://mysite.dev/', // change }, - astroRoot: './src', }; diff --git a/examples/snowpack/astro.config.mjs b/examples/snowpack/astro.config.mjs index 47fc0d32ea..eedfc34db3 100644 --- a/examples/snowpack/astro.config.mjs +++ b/examples/snowpack/astro.config.mjs @@ -1,6 +1,6 @@ export default { projectRoot: '.', - astroRoot: './src', + pages: './src/pages', dist: './dist', public: './public', extensions: { diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index 5db544b2ae..db0b775896 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -3,7 +3,7 @@ import type { ImportSpecifier, ImportDefaultSpecifier, ImportNamespaceSpecifier export interface AstroConfigRaw { dist: string; projectRoot: string; - astroRoot: string; + pages: string; public: string; jsx?: string; } @@ -17,7 +17,7 @@ export interface AstroMarkdownOptions { export interface AstroConfig { dist: string; projectRoot: URL; - astroRoot: URL; + pages: URL; public: URL; renderers?: string[]; /** Options for rendering markdown content */ diff --git a/packages/astro/src/build.ts b/packages/astro/src/build.ts index f8faf1b772..afd0ef5b97 100644 --- a/packages/astro/src/build.ts +++ b/packages/astro/src/build.ts @@ -41,9 +41,8 @@ function isRemote(url: string) { /** The primary build action */ export async function build(astroConfig: AstroConfig, logging: LogOptions = defaultLogging): Promise<0 | 1> { - const { projectRoot, astroRoot } = astroConfig; + const { projectRoot, pages: pagesRoot } = astroConfig; const dist = new URL(astroConfig.dist + '/', projectRoot); - const pageRoot = new URL('./pages/', astroRoot); const buildState: BuildOutput = {}; const depTree: BundleMap = {}; const timer: Record = {}; @@ -70,7 +69,7 @@ export async function build(astroConfig: AstroConfig, logging: LogOptions = defa * Source files are built in parallel and stored in memory. Most assets are also gathered here, too. */ timer.build = performance.now(); - const pages = await allPages(pageRoot); + const pages = await allPages(pagesRoot); info(logging, 'build', yellow('! building pages...')); const release = trapWarn(); // Vue also console.warns, this silences it. await Promise.all( diff --git a/packages/astro/src/build/page.ts b/packages/astro/src/build/page.ts index ccc04fe2ea..df76f77ef6 100644 --- a/packages/astro/src/build/page.ts +++ b/packages/astro/src/build/page.ts @@ -22,9 +22,9 @@ export function getPageType(filepath: URL): 'collection' | 'static' { } /** Build collection */ -export async function buildCollectionPage({ astroConfig, filepath, logging, mode, runtime, site, resolvePackageUrl, buildState }: PageBuildOptions): Promise { - const pagesPath = new URL('./pages/', astroConfig.astroRoot); - const srcURL = filepath.pathname.replace(pagesPath.pathname, '/'); +export async function buildCollectionPage({ astroConfig, filepath, runtime, site, buildState }: PageBuildOptions): Promise { + const { pages: pagesRoot } = astroConfig; + const srcURL = filepath.pathname.replace(pagesRoot.pathname, '/'); const outURL = srcURL.replace(/\$([^.]+)\.astro$/, '$1'); const builtURLs = new Set(); // !important: internal cache that prevents building the same URLs @@ -89,8 +89,8 @@ export async function buildCollectionPage({ astroConfig, filepath, logging, mode /** Build static page */ export async function buildStaticPage({ astroConfig, buildState, filepath, runtime }: PageBuildOptions): Promise { - const pagesPath = new URL('./pages/', astroConfig.astroRoot); - const url = filepath.pathname.replace(pagesPath.pathname, '/').replace(/(index)?\.(astro|md)$/, ''); + const { pages: pagesRoot } = astroConfig; + const url = filepath.pathname.replace(pagesRoot.pathname, '/').replace(/(index)?\.(astro|md)$/, ''); // build page in parallel await Promise.all([ diff --git a/packages/astro/src/build/util.ts b/packages/astro/src/build/util.ts index 250b867f4d..3132956e45 100644 --- a/packages/astro/src/build/util.ts +++ b/packages/astro/src/build/util.ts @@ -1,6 +1,7 @@ import type { AstroConfig } from '../@types/astro'; import { performance } from 'perf_hooks'; +import fs from 'fs'; import path from 'path'; import { URL } from 'url'; @@ -16,28 +17,43 @@ export function canonicalURL(url: string, base?: string): URL { /** Resolve final output URL */ export function getDistPath(specifier: string, { astroConfig, srcPath }: { astroConfig: AstroConfig; srcPath: URL }): string { if (specifier[0] === '/') return specifier; // assume absolute URLs are correct - const pagesDir = path.join(astroConfig.astroRoot.pathname, 'pages'); + const { pages: pagesRoot, projectRoot } = astroConfig; - const fileLoc = path.posix.join(path.posix.dirname(srcPath.pathname), specifier); - const projectLoc = path.posix.relative(astroConfig.astroRoot.pathname, fileLoc); + const fileLoc = new URL(specifier, srcPath); + const projectLoc = fileLoc.pathname.replace(projectRoot.pathname, ''); - const isPage = fileLoc.includes(pagesDir); + const isPage = fileLoc.pathname.includes(pagesRoot.pathname); // if this lives above src/pages, return that URL if (isPage) { - const [, publicURL] = projectLoc.split(pagesDir); + const [, publicURL] = projectLoc.split(pagesRoot.pathname); return publicURL || '/index.html'; // if this is missing, this is the root } // otherwise, return /_astro/* url return '/_astro/' + projectLoc; } -/** Given a final output URL, guess at src path (may be inaccurate) */ -export function getSrcPath(url: string, { astroConfig }: { astroConfig: AstroConfig }): URL { - if (url.startsWith('/_astro/')) { - return new URL(url.replace(/^\/_astro\//, ''), astroConfig.astroRoot); +/** Given a final output URL, guess at src path (may be inaccurate; only for non-pages) */ +export function getSrcPath(distURL: string, { astroConfig }: { astroConfig: AstroConfig }): URL { + if (distURL.startsWith('/_astro/')) { + return new URL('.' + distURL.replace(/^\/_astro\//, ''), astroConfig.projectRoot); + } else if (distURL === '/index.html') { + return new URL('./index.astro', astroConfig.pages); } - let srcFile = url.replace(/^\//, '').replace(/\/index.html$/, '.astro'); - return new URL('./pages/' + srcFile, astroConfig.astroRoot); + + const possibleURLs = [ + new URL('.' + distURL, astroConfig.public), // public asset + new URL('.' + distURL.replace(/([^\/])+\/d+\/index.html/, '$$1.astro'), astroConfig.pages), // collection page + new URL('.' + distURL.replace(/\/index\.html$/, '.astro'), astroConfig.pages), // page + // TODO: Astro pages (this isn’t currently used for that lookup) + ]; + + // if this is in public/ or pages/, return that + for (const possibleURL of possibleURLs) { + if (fs.existsSync(possibleURL)) return possibleURL; + } + + // otherwise resolve relative to project + return new URL('.' + distURL, astroConfig.projectRoot); } /** Stop timer & format time for profiling */ diff --git a/packages/astro/src/compiler/codegen/index.ts b/packages/astro/src/compiler/codegen/index.ts index d2b661116d..4a7b4a3351 100644 --- a/packages/astro/src/compiler/codegen/index.ts +++ b/packages/astro/src/compiler/codegen/index.ts @@ -141,14 +141,13 @@ const PlainExtensions = new Set(['.js', '.jsx', '.ts', '.tsx']); /** Generate Astro-friendly component import */ function getComponentWrapper(_name: string, { url, importSpecifier }: ComponentInfo, opts: GetComponentWrapperOptions) { const { astroConfig, filename } = opts; - const { astroRoot } = astroConfig; const currFileUrl = new URL(`file://${filename}`); const [name, kind] = _name.split(':'); const getComponentUrl = () => { const componentExt = path.extname(url); const ext = PlainExtensions.has(componentExt) ? '.js' : `${componentExt}.js`; const outUrl = new URL(url, currFileUrl); - return '/_astro/' + path.posix.relative(astroRoot.pathname, outUrl.pathname).replace(/\.[^.]+$/, ext); + return '/_astro/' + outUrl.href.replace(astroConfig.projectRoot.href, '').replace(/\.[^.]+$/, ext); }; const getComponentExport = () => { switch (importSpecifier.type) { diff --git a/packages/astro/src/compiler/transform/module-scripts.ts b/packages/astro/src/compiler/transform/module-scripts.ts index aff1ec4f6d..46defb1bd9 100644 --- a/packages/astro/src/compiler/transform/module-scripts.ts +++ b/packages/astro/src/compiler/transform/module-scripts.ts @@ -1,13 +1,11 @@ import type { Transformer } from '../../@types/transformer'; import type { CompileOptions } from '../../@types/compiler'; -import path from 'path'; import { getAttrValue, setAttrValue } from '../../ast.js'; /** Transform