Skip to content

chore: run prettier on samples #1415

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 0 additions & 3 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,5 @@ package-lock.json
/packages/lit-dev-content/_dev/
/packages/lit-dev-content/_site/
/packages/lit-dev-content/rollupout/
# TODO(aomarks) Would be nice to format samples, but Prettier doesn't always do
# a great job compared to our manual formatting.
/packages/lit-dev-content/samples/

.wireit
26 changes: 13 additions & 13 deletions lit-dev.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,48 @@
"folders": [
{
"name": "lit-dev-content",
"path": "packages/lit-dev-content"
"path": "packages/lit-dev-content",
},
{
"name": "lit-dev-tools-cjs",
"path": "packages/lit-dev-tools-cjs"
"path": "packages/lit-dev-tools-cjs",
},
{
"name": "lit-dev-tools-esm",
"path": "packages/lit-dev-tools-esm"
"path": "packages/lit-dev-tools-esm",
},
{
"name": "lit-dev-tests",
"path": "packages/lit-dev-tests"
"path": "packages/lit-dev-tests",
},
{
"name": "lit-dev-api",
"path": "packages/lit-dev-api"
"path": "packages/lit-dev-api",
},
{
"name": "lit-dev-server",
"path": "packages/lit-dev-server"
"path": "packages/lit-dev-server",
},
{
"name": "lit-dev-discord-bot",
"path": "packages/lit-dev-discord-bot"
"path": "packages/lit-dev-discord-bot",
},
{
"name": "lit.dev",
"path": "."
}
"path": ".",
},
],
"settings": {
"files.insertFinalNewline": true,
"files.trimTrailingWhitespace": true,
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
"editor.defaultFormatter": "esbenp.prettier-vscode",
},
"search.exclude": {
"api-data/*/repo": true
"api-data/*/repo": true,
},
},
"extensions": {
"recommendations": ["esbenp.prettier-vscode"]
}
"recommendations": ["esbenp.prettier-vscode"],
},
}
12 changes: 7 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
},
"devDependencies": {
"playground-elements": "^0.20.0",
"prettier": "^2.1.2",
"prettier": "^3.5.3",
"typescript": "~4.7.4",
"wireit": "^0.14.0"
}
Expand Down
6 changes: 3 additions & 3 deletions packages/lit-dev-cloudbuild-cleanup/src/cleanup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ async function main() {
if (!PROJECT_ID || !REPO_NAME || !_DEPLOY_REGION) {
console.log({PROJECT_ID, REPO_NAME, _DEPLOY_REGION});
throw new Error(
'Missing one or more required environment variables: PROJECT_ID, REPO_NAME, _DEPLOY_REGION'
'Missing one or more required environment variables: PROJECT_ID, REPO_NAME, _DEPLOY_REGION',
);
}

Expand Down Expand Up @@ -98,7 +98,7 @@ async function main() {
!rev.metadata.name
) {
throw new Error(
`Found revision with missing necessary metadata: ${JSON.stringify(rev)}`
`Found revision with missing necessary metadata: ${JSON.stringify(rev)}`,
);
}

Expand Down Expand Up @@ -160,7 +160,7 @@ async function main() {
} else if (!t.tag.startsWith('main')) {
// Unrecognized tags are kept just in case
console.log(
`Found unrecognized tag "${t.tag}". This will not be deleted.`
`Found unrecognized tag "${t.tag}". This will not be deleted.`,
);
revisionsToKeep.add(t.revisionName);
return true;
Expand Down
64 changes: 32 additions & 32 deletions packages/lit-dev-content/.eleventy.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ module.exports = function (eleventyConfig) {

eleventyConfig.addWatchTarget('../lit-dev-api/api-data/*/*.json');
eleventyConfig.addWatchTarget(
'../lit-dev-content/samples/tutorials/**/tutorial.json'
'../lit-dev-content/samples/tutorials/**/tutorial.json',
);
eleventyConfig.addWatchTarget('../lit-dev-content/samples/tutorials/**/*.md');
eleventyConfig.addWatchTarget('../lit-dev-content/rollupout/server/*');
Expand Down Expand Up @@ -119,14 +119,14 @@ ${content}
Object.assign(new state.Token('div_open', 'div', 1), {
attrs: [['class', `heading ${headingTag}`]],
block: true,
})
}),
);
state.tokens.splice(
idx + 4,
0,
Object.assign(new state.Token('div_close', 'div', -1), {
block: true,
})
}),
);
linkAfterHeaderBase(slug, opts, state, idx + 1);
};
Expand Down Expand Up @@ -165,16 +165,16 @@ ${content}
function (url, latestVersion) {
if (!latestVersion) {
throw new Error(
`No latestVersion provided to 'removeLatestVersionFromUrl`
`No latestVersion provided to 'removeLatestVersionFromUrl`,
);
}
if (!url.includes(`/${latestVersion}/`)) {
throw new Error(
`'${url}' does not include the latestVersion versioned path segment`
`'${url}' does not include the latestVersion versioned path segment`,
);
}
return url.replace(`/${latestVersion}/`, '/');
}
},
);

/**
Expand All @@ -191,11 +191,11 @@ ${content}
}
if (!latestVersion) {
throw new Error(
`latestVersion not provided to 'fixUnversionedCrossLinks`
`latestVersion not provided to 'fixUnversionedCrossLinks`,
);
}
return content.replaceAll(`/docs/${latestVersion}/`, '/docs/');
}
},
);

eleventyConfig.addFilter('removeExtension', function (url) {
Expand Down Expand Up @@ -446,7 +446,7 @@ ${content}
if (location === undefined) {
throw new Error(
`Ambiguous symbol ${symbol}. ` +
`Options: ${locations.map((l) => l.anchor).join(', ')}`
`Options: ${locations.map((l) => l.anchor).join(', ')}`,
);
}

Expand All @@ -459,17 +459,17 @@ ${content}
'api-v3',
'/docs/v3/api',
JSON.parse(
fsSync.readFileSync('../lit-dev-api/api-data/lit-3/symbols.json', 'utf8')
)
fsSync.readFileSync('../lit-dev-api/api-data/lit-3/symbols.json', 'utf8'),
),
);

addApiShortcode(
'api',
'/docs/v2/api',
// Don't use require() because of Node caching in watch mode.
JSON.parse(
fsSync.readFileSync('../lit-dev-api/api-data/lit-2/symbols.json', 'utf8')
)
fsSync.readFileSync('../lit-dev-api/api-data/lit-2/symbols.json', 'utf8'),
),
);

addApiShortcode(
Expand All @@ -478,9 +478,9 @@ ${content}
JSON.parse(
fsSync.readFileSync(
'../lit-dev-api/api-data/lit-html-1/symbols.json',
'utf8'
)
)
'utf8',
),
),
);

addApiShortcode(
Expand All @@ -489,9 +489,9 @@ ${content}
JSON.parse(
fsSync.readFileSync(
'../lit-dev-api/api-data/lit-element-2/symbols.json',
'utf8'
)
)
'utf8',
),
),
);

/**
Expand Down Expand Up @@ -520,7 +520,7 @@ ${content}
`CleanCSS errors/warnings on file ${path}:\n\n${[
...result.errors,
...result.warnings,
].join('\n')}`
].join('\n')}`,
);
}
return `<style>${result.styles}</style>`;
Expand Down Expand Up @@ -554,14 +554,14 @@ ${content}
// Source: https://github.com/11ty/eleventy-base-blog/blob/master/.eleventy.js
eleventyConfig.addFilter('readableDate', (dateObj) => {
return luxon.DateTime.fromJSDate(dateObj, {zone: 'utc'}).toFormat(
'LLL d, yyyy'
'LLL d, yyyy',
);
});

// https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-date-string
eleventyConfig.addFilter('yyyymmdd', (dateObj) => {
return luxon.DateTime.fromJSDate(dateObj, {zone: 'utc'}).toFormat(
'yyyy-LL-dd'
'yyyy-LL-dd',
);
});

Expand All @@ -587,15 +587,15 @@ ${content}
ENV.eleventyOutDir + '/docs/v3/introduction.html',
ENV.eleventyOutDir + '/docs/v3/*/index.html',
],
{ignore: ENV.eleventyOutDir + '/docs/(v1|v2|v3)/index.html'}
{ignore: ENV.eleventyOutDir + '/docs/(v1|v2|v3)/index.html'},
)
).filter(
// TODO(aomarks) This is brittle, we need a way to annotate inside an md
// file that a page shouldn't be generated.
(file) =>
!file.includes('why-lit') &&
!file.includes('getting-started') &&
!file.includes('browser-support')
!file.includes('browser-support'),
);
await Promise.all(emptyDocsIndexFiles.map((path) => fs.unlink(path)));

Expand All @@ -611,32 +611,32 @@ ${content}
// immediately, instead of triggering an Eleventy build.
await symlinkForce(
path.join(__dirname, 'site', 'css'),
path.join(__dirname, ENV.eleventyOutDir, 'css')
path.join(__dirname, ENV.eleventyOutDir, 'css'),
);
await symlinkForce(
path.join(__dirname, 'site', 'images'),
path.join(__dirname, ENV.eleventyOutDir, 'images')
path.join(__dirname, ENV.eleventyOutDir, 'images'),
);
await symlinkForce(
path.join(__dirname, 'site', 'fonts'),
path.join(__dirname, ENV.eleventyOutDir, 'fonts')
path.join(__dirname, ENV.eleventyOutDir, 'fonts'),
);
await symlinkForce(
path.join(__dirname, 'samples'),
path.join(__dirname, ENV.eleventyOutDir, 'samples')
path.join(__dirname, ENV.eleventyOutDir, 'samples'),
);

// Symlink lib -> _dev/js. This lets us directly reference tsc outputs in
// dev mode, instead of the Rollup bundles we use for production.
await symlinkForce(
path.join(__dirname, 'lib'),
path.join(__dirname, ENV.eleventyOutDir, 'js')
path.join(__dirname, ENV.eleventyOutDir, 'js'),
);
} else {
// Inline all Playground project files directly into their manifests, to
// cut down on requests per project.
await inlinePlaygroundFilesIntoManifests(
`${ENV.eleventyOutDir}/samples/**/project.json`
`${ENV.eleventyOutDir}/samples/**/project.json`,
);

// Pre-compress all outputs as .br and .gz files so the server can read
Expand All @@ -649,7 +649,7 @@ ${content}
await fs.writeFile(
path.join(ENV.eleventyOutDir, 'csp-inline-script-hashes.txt'),
[...cspInlineScriptHashes].join('\n'),
'utf8'
'utf8',
);
}
});
Expand All @@ -676,7 +676,7 @@ ${content}
// In prod SSR should use the lit templates run through the minifier.
if (!DEV) {
componentModules = componentModules.map((componentPath) =>
componentPath.replace('lib/components', 'rollupout/server')
componentPath.replace('lib/components', 'rollupout/server'),
);
}

Expand Down
8 changes: 5 additions & 3 deletions packages/lit-dev-content/samples/_check-code-helpers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import {PostDoc} from 'postdoc-lib';

export const installCodeChecker = async (checkCode: () => Promise<{passed: boolean, message?: string}>) => {
export const installCodeChecker = async (
checkCode: () => Promise<{passed: boolean; message?: string}>,
) => {
const postDoc = new PostDoc({
messageTarget: window.top!,
messageReceiver: window,
Expand All @@ -15,9 +17,9 @@ export const installCodeChecker = async (checkCode: () => Promise<{passed: boole
postDoc.postMessage({status, message});
break;
}
}
},
});

await postDoc.handshake;
postDoc.postMessage({status: 'READY'});
}
};
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<script type="module" src="./my-element.js"></script>

<my-element></my-element>
<my-element></my-element>
Loading