mirror of
https://github.com/jakejarvis/jarv.is.git
synced 2025-04-26 22:28:30 -04:00
add getStaticProps
types
This commit is contained in:
parent
5f22b7989d
commit
887c24d317
@ -88,19 +88,14 @@ const Footer = ({ ...rest }: FooterProps) => {
|
|||||||
<Row>
|
<Row>
|
||||||
<div>
|
<div>
|
||||||
Content{" "}
|
Content{" "}
|
||||||
<PlainLink
|
<PlainLink href="/license/" prefetch={false} title={config.license} underline={false}>
|
||||||
href="/license/"
|
licensed under {config.licenseAbbr}
|
||||||
prefetch={false}
|
|
||||||
title="Creative Commons Attribution 4.0 International"
|
|
||||||
underline={false}
|
|
||||||
>
|
|
||||||
licensed under CC-BY-4.0
|
|
||||||
</PlainLink>
|
</PlainLink>
|
||||||
,{" "}
|
,{" "}
|
||||||
<PlainLink href="/previously/" prefetch={false} title="Previously on..." underline={false}>
|
<PlainLink href="/previously/" prefetch={false} title="Previously on..." underline={false}>
|
||||||
2001
|
{config.copyrightYearStart}
|
||||||
</PlainLink>{" "}
|
</PlainLink>{" "}
|
||||||
– {new Date(process.env.NEXT_PUBLIC_RELEASE_DATE || Date.now()).getUTCFullYear()}.
|
– {new Date(process.env.RELEASE_DATE || Date.now()).getUTCFullYear()}.
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
|
@ -2,7 +2,7 @@ import Link from "../Link";
|
|||||||
import Time from "../Time";
|
import Time from "../Time";
|
||||||
import { styled } from "../../lib/styles/stitches.config";
|
import { styled } from "../../lib/styles/stitches.config";
|
||||||
import type { ReactElement } from "react";
|
import type { ReactElement } from "react";
|
||||||
import type { NoteFrontMatter } from "../../types";
|
import type { NotesByYear } from "../../types";
|
||||||
|
|
||||||
const Section = styled("section", {
|
const Section = styled("section", {
|
||||||
fontSize: "1.1em",
|
fontSize: "1.1em",
|
||||||
@ -55,9 +55,7 @@ const PostDate = styled(Time, {
|
|||||||
});
|
});
|
||||||
|
|
||||||
export type NotesListProps = {
|
export type NotesListProps = {
|
||||||
notesByYear: {
|
notesByYear: NotesByYear;
|
||||||
[year: string]: NoteFrontMatter[];
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
const NotesList = ({ notesByYear }: NotesListProps) => {
|
const NotesList = ({ notesByYear }: NotesListProps) => {
|
||||||
|
@ -6,4 +6,4 @@ import path from "path";
|
|||||||
export const NOTES_DIR = path.join(process.cwd(), "notes");
|
export const NOTES_DIR = path.join(process.cwd(), "notes");
|
||||||
|
|
||||||
// normalize the timestamp saved when building/deploying (see next.config.js) and fall back to right now:
|
// normalize the timestamp saved when building/deploying (see next.config.js) and fall back to right now:
|
||||||
export const RELEASE_DATE = new Date(process.env.NEXT_PUBLIC_RELEASE_DATE || Date.now()).toISOString();
|
export const RELEASE_DATE = new Date(process.env.RELEASE_DATE || Date.now()).toISOString();
|
||||||
|
@ -16,6 +16,10 @@ module.exports = {
|
|||||||
shortDescription: "Front-End Web Developer in Boston, MA",
|
shortDescription: "Front-End Web Developer in Boston, MA",
|
||||||
longDescription:
|
longDescription:
|
||||||
"Hi there! I'm a frontend web developer based in Boston, Massachusetts specializing in the JAMstack, modern JavaScript frameworks, and progressive web apps.",
|
"Hi there! I'm a frontend web developer based in Boston, Massachusetts specializing in the JAMstack, modern JavaScript frameworks, and progressive web apps.",
|
||||||
|
license: "Creative Commons Attribution 4.0 International",
|
||||||
|
licenseAbbr: "CC-BY-4.0",
|
||||||
|
licenseUrl: "https://creativecommons.org/licenses/by/4.0/",
|
||||||
|
copyrightYearStart: 2001,
|
||||||
githubRepo: "jakejarvis/jarv.is",
|
githubRepo: "jakejarvis/jarv.is",
|
||||||
verifyGoogle: "qQhmLTwjNWYgQ7W42nSTq63xIrTch13X_11mmxBE9zk",
|
verifyGoogle: "qQhmLTwjNWYgQ7W42nSTq63xIrTch13X_11mmxBE9zk",
|
||||||
verifyBing: "164551986DA47F7F6FC0D21A93FFFCA6",
|
verifyBing: "164551986DA47F7F6FC0D21A93FFFCA6",
|
||||||
|
@ -3,7 +3,7 @@ import { getAllNotes } from "./parse-notes";
|
|||||||
import * as config from "../config";
|
import * as config from "../config";
|
||||||
import { RELEASE_DATE } from "../config/constants";
|
import { RELEASE_DATE } from "../config/constants";
|
||||||
import { favicons } from "../config/seo";
|
import { favicons } from "../config/seo";
|
||||||
import type { GetServerSidePropsContext, PreviewData } from "next";
|
import type { GetServerSidePropsContext, GetServerSidePropsResult, PreviewData } from "next";
|
||||||
import type { ParsedUrlQuery } from "querystring";
|
import type { ParsedUrlQuery } from "querystring";
|
||||||
|
|
||||||
export type BuildFeedOptions = {
|
export type BuildFeedOptions = {
|
||||||
@ -11,12 +11,12 @@ export type BuildFeedOptions = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
// handles literally *everything* about building the server-side rss/atom feeds and writing the response.
|
// handles literally *everything* about building the server-side rss/atom feeds and writing the response.
|
||||||
// all the page needs to do is `return buildFeed(context, { format: "rss" })` from getServerSideProps.
|
// all the page needs to do is `return buildFeed(context, "rss")` from getServerSideProps.
|
||||||
export const buildFeed = async (
|
export const buildFeed = async (
|
||||||
context: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>,
|
context: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>,
|
||||||
type: "rss" | "atom" | "json",
|
type: "rss" | "atom" | "json",
|
||||||
options?: BuildFeedOptions
|
options?: BuildFeedOptions
|
||||||
): Promise<{ props: Record<string, unknown> }> => {
|
): Promise<GetServerSidePropsResult<Record<string, never>>> => {
|
||||||
const { res } = context;
|
const { res } = context;
|
||||||
|
|
||||||
// https://github.com/jpmonette/feed#example
|
// https://github.com/jpmonette/feed#example
|
||||||
@ -25,7 +25,7 @@ export const buildFeed = async (
|
|||||||
link: `${config.baseUrl}/`,
|
link: `${config.baseUrl}/`,
|
||||||
title: config.siteName,
|
title: config.siteName,
|
||||||
description: config.longDescription,
|
description: config.longDescription,
|
||||||
copyright: "https://creativecommons.org/licenses/by/4.0/",
|
copyright: config.licenseUrl,
|
||||||
updated: new Date(RELEASE_DATE),
|
updated: new Date(RELEASE_DATE),
|
||||||
image: `${config.baseUrl}${favicons.meJpg.src}`,
|
image: `${config.baseUrl}${favicons.meJpg.src}`,
|
||||||
feedLinks: {
|
feedLinks: {
|
||||||
|
@ -13,7 +13,10 @@ import type { NoteFrontMatter } from "../../types";
|
|||||||
|
|
||||||
export const getNoteSlugs = async (): Promise<string[]> => {
|
export const getNoteSlugs = async (): Promise<string[]> => {
|
||||||
// list all .mdx files in NOTES_DIR
|
// list all .mdx files in NOTES_DIR
|
||||||
const mdxFiles = await glob("*.mdx", { cwd: NOTES_DIR });
|
const mdxFiles = await glob("*.mdx", {
|
||||||
|
cwd: NOTES_DIR,
|
||||||
|
dot: false,
|
||||||
|
});
|
||||||
|
|
||||||
// strip the .mdx extensions from filenames
|
// strip the .mdx extensions from filenames
|
||||||
const slugs = mdxFiles.map((fileName) => fileName.replace(/\.mdx$/, ""));
|
const slugs = mdxFiles.map((fileName) => fileName.replace(/\.mdx$/, ""));
|
||||||
@ -51,14 +54,12 @@ export const getNoteData = async (
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
// returns the front matter of ALL notes, sorted reverse chronologically
|
// returns the parsed front matter of ALL notes, sorted reverse chronologically
|
||||||
export const getAllNotes = async (): Promise<NoteFrontMatter[]> => {
|
export const getAllNotes = async (): Promise<NoteFrontMatter[]> => {
|
||||||
const slugs = await getNoteSlugs();
|
const slugs = await getNoteSlugs();
|
||||||
|
|
||||||
// for each slug, query its front matter
|
// for each slug, query its front matter
|
||||||
const data = await pMap(slugs, async (slug) => (await getNoteData(slug)).frontMatter, {
|
const data = await pMap(slugs, async (slug) => (await getNoteData(slug)).frontMatter);
|
||||||
stopOnError: true,
|
|
||||||
});
|
|
||||||
|
|
||||||
// sort the results by date
|
// sort the results by date
|
||||||
data.sort((note1, note2) => (note1.date > note2.date ? -1 : 1));
|
data.sort((note1, note2) => (note1.date > note2.date ? -1 : 1));
|
||||||
|
@ -24,8 +24,8 @@ module.exports = (phase, { defaultConfig }) => {
|
|||||||
trailingSlash: true,
|
trailingSlash: true,
|
||||||
productionBrowserSourceMaps: true,
|
productionBrowserSourceMaps: true,
|
||||||
env: {
|
env: {
|
||||||
// freeze build timestamp for when serverless pages need a "last updated" date:
|
// freeze build timestamp for when server-side pages need a "last updated" date:
|
||||||
NEXT_PUBLIC_RELEASE_DATE: new Date().toISOString(),
|
RELEASE_DATE: new Date().toISOString(),
|
||||||
// check if we're running locally via `next dev`:
|
// check if we're running locally via `next dev`:
|
||||||
IS_DEV_SERVER: phase === PHASE_DEVELOPMENT_SERVER,
|
IS_DEV_SERVER: phase === PHASE_DEVELOPMENT_SERVER,
|
||||||
// https://nextjs.org/docs/api-reference/cli#development
|
// https://nextjs.org/docs/api-reference/cli#development
|
||||||
|
@ -26,7 +26,7 @@ const handler = async (req: NextApiRequest, res: NextApiResponse) => {
|
|||||||
|
|
||||||
// these are both backups to client-side validations just in case someone squeezes through without them. the codes
|
// these are both backups to client-side validations just in case someone squeezes through without them. the codes
|
||||||
// are identical so they're caught in the same fashion.
|
// are identical so they're caught in the same fashion.
|
||||||
if (!body || !body.name || !body.email || !body.message) {
|
if (!body.name || !body.email || !body.message) {
|
||||||
// all fields are required
|
// all fields are required
|
||||||
throw new Error("USER_MISSING_DATA");
|
throw new Error("USER_MISSING_DATA");
|
||||||
}
|
}
|
||||||
@ -63,7 +63,7 @@ const handler = async (req: NextApiRequest, res: NextApiResponse) => {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
const validateCaptcha = async (formResponse: unknown) => {
|
const validateCaptcha = async (formResponse: unknown): Promise<unknown> => {
|
||||||
const response = await fetch(HCAPTCHA_API_ENDPOINT, {
|
const response = await fetch(HCAPTCHA_API_ENDPOINT, {
|
||||||
method: "POST",
|
method: "POST",
|
||||||
headers: {
|
headers: {
|
||||||
@ -76,13 +76,12 @@ const validateCaptcha = async (formResponse: unknown) => {
|
|||||||
}),
|
}),
|
||||||
});
|
});
|
||||||
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
const result = await response.json();
|
||||||
const result: any = await response.json();
|
|
||||||
|
|
||||||
return result.success as boolean;
|
return result.success;
|
||||||
};
|
};
|
||||||
|
|
||||||
const sendToAirtable = async (data: unknown) => {
|
const sendToAirtable = async (data: unknown): Promise<boolean> => {
|
||||||
const response = await fetch(`${AIRTABLE_API_ENDPOINT}${AIRTABLE_BASE}/Messages`, {
|
const response = await fetch(`${AIRTABLE_API_ENDPOINT}${AIRTABLE_BASE}/Messages`, {
|
||||||
method: "POST",
|
method: "POST",
|
||||||
headers: {
|
headers: {
|
||||||
|
@ -54,7 +54,7 @@ const handler = async (req: NextApiRequest, res: NextApiResponse) => {
|
|||||||
await logServerError(error);
|
await logServerError(error);
|
||||||
|
|
||||||
// 500 Internal Server Error
|
// 500 Internal Server Error
|
||||||
return res.status(500).json({ success: false, message });
|
return res.status(500).json({ message });
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -75,7 +75,7 @@ const getAccessToken = async () => {
|
|||||||
|
|
||||||
const { access_token: token } = await response.json();
|
const { access_token: token } = await response.json();
|
||||||
|
|
||||||
return token as string;
|
return token;
|
||||||
};
|
};
|
||||||
|
|
||||||
const getNowPlaying = async (token: string): Promise<Track | false> => {
|
const getNowPlaying = async (token: string): Promise<Track | false> => {
|
||||||
@ -120,7 +120,7 @@ const getTopTracks = async (token: string): Promise<Track[]> => {
|
|||||||
|
|
||||||
const { items } = (await response.json()) as { items: SpotifyTrackSchema[] };
|
const { items } = (await response.json()) as { items: SpotifyTrackSchema[] };
|
||||||
|
|
||||||
const tracks: Track[] = items.map((track: SpotifyTrackSchema) => ({
|
const tracks = items.map<Track>((track) => ({
|
||||||
artist: track.artists.map((artist) => artist.name).join(", "),
|
artist: track.artists.map((artist) => artist.name).join(", "),
|
||||||
title: track.name,
|
title: track.name,
|
||||||
album: track.album.name,
|
album: track.album.name,
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
import { buildFeed } from "../lib/helpers/build-feed";
|
import { buildFeed } from "../lib/helpers/build-feed";
|
||||||
import type { GetServerSideProps } from "next";
|
import type { GetServerSideProps } from "next";
|
||||||
|
|
||||||
export const getServerSideProps: GetServerSideProps = async (context) => {
|
export const getServerSideProps: GetServerSideProps<Record<string, never>> = async (context) => {
|
||||||
return buildFeed(context, "atom");
|
return buildFeed(context, "atom");
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
import { buildFeed } from "../lib/helpers/build-feed";
|
import { buildFeed } from "../lib/helpers/build-feed";
|
||||||
import type { GetServerSideProps } from "next";
|
import type { GetServerSideProps } from "next";
|
||||||
|
|
||||||
export const getServerSideProps: GetServerSideProps = async (context) => {
|
export const getServerSideProps: GetServerSideProps<Record<string, never>> = async (context) => {
|
||||||
return buildFeed(context, "rss");
|
return buildFeed(context, "rss");
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -69,8 +69,14 @@ const Note = ({ frontMatter, source }: NoteWithSource) => {
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getStaticProps: GetStaticProps = async ({ params }) => {
|
export const getStaticProps: GetStaticProps<NoteWithSource, Pick<NoteFrontMatter, "slug">> = async ({ params }) => {
|
||||||
const { frontMatter, source } = await compileNote((params as Pick<NoteFrontMatter, "slug">).slug);
|
if (!params || !params.slug) {
|
||||||
|
return {
|
||||||
|
notFound: true,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const { frontMatter, source } = await compileNote(params.slug);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
props: {
|
props: {
|
||||||
|
@ -1,15 +1,21 @@
|
|||||||
import { NextSeo } from "next-seo";
|
import { NextSeo } from "next-seo";
|
||||||
import Content from "../../components/Content";
|
import Content from "../../components/Content";
|
||||||
import NotesList, { NotesListProps } from "../../components/NotesList";
|
import NotesList from "../../components/NotesList";
|
||||||
import { getAllNotes } from "../../lib/helpers/parse-notes";
|
import { getAllNotes } from "../../lib/helpers/parse-notes";
|
||||||
|
import { authorName } from "../../lib/config";
|
||||||
import type { GetStaticProps } from "next";
|
import type { GetStaticProps } from "next";
|
||||||
|
import type { NotesByYear } from "../../types";
|
||||||
|
|
||||||
const Notes = ({ notesByYear }: NotesListProps) => {
|
type StaticProps = {
|
||||||
|
notesByYear: NotesByYear;
|
||||||
|
};
|
||||||
|
|
||||||
|
const Notes = ({ notesByYear }: StaticProps) => {
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<NextSeo
|
<NextSeo
|
||||||
title="Notes"
|
title="Notes"
|
||||||
description="Recent posts by Jake Jarvis."
|
description={`Recent posts by ${authorName}.`}
|
||||||
openGraph={{
|
openGraph={{
|
||||||
title: "Notes",
|
title: "Notes",
|
||||||
}}
|
}}
|
||||||
@ -22,10 +28,10 @@ const Notes = ({ notesByYear }: NotesListProps) => {
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getStaticProps: GetStaticProps = async () => {
|
export const getStaticProps: GetStaticProps<StaticProps> = async () => {
|
||||||
// parse the year of each note and group them together
|
// parse the year of each note and group them together
|
||||||
const notes = await getAllNotes();
|
const notes = await getAllNotes();
|
||||||
const notesByYear: NotesListProps["notesByYear"] = {};
|
const notesByYear: NotesByYear = {};
|
||||||
|
|
||||||
notes.forEach((note) => {
|
notes.forEach((note) => {
|
||||||
const year = new Date(note.date).getUTCFullYear();
|
const year = new Date(note.date).getUTCFullYear();
|
||||||
|
@ -42,7 +42,11 @@ const GitHubLogo = styled(OctocatOcticon, {
|
|||||||
fill: "$text",
|
fill: "$text",
|
||||||
});
|
});
|
||||||
|
|
||||||
const Projects = ({ repos }: { repos: Project[] }) => {
|
type StaticProps = {
|
||||||
|
repos: Project[];
|
||||||
|
};
|
||||||
|
|
||||||
|
const Projects = ({ repos }: StaticProps) => {
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<NextSeo
|
<NextSeo
|
||||||
@ -71,7 +75,7 @@ const Projects = ({ repos }: { repos: Project[] }) => {
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getStaticProps: GetStaticProps = async () => {
|
export const getStaticProps: GetStaticProps<StaticProps> = async () => {
|
||||||
// don't fail the entire site build if the required API key for this page is missing
|
// don't fail the entire site build if the required API key for this page is missing
|
||||||
if (typeof process.env.GH_PUBLIC_TOKEN === "undefined" || process.env.GH_PUBLIC_TOKEN === "") {
|
if (typeof process.env.GH_PUBLIC_TOKEN === "undefined" || process.env.GH_PUBLIC_TOKEN === "") {
|
||||||
console.warn(`ERROR: I can't fetch any GitHub projects without "GH_PUBLIC_TOKEN" set! Skipping for now...`);
|
console.warn(`ERROR: I can't fetch any GitHub projects without "GH_PUBLIC_TOKEN" set! Skipping for now...`);
|
||||||
@ -130,11 +134,11 @@ export const getStaticProps: GetStaticProps = async () => {
|
|||||||
const repos = results.map<Project>(({ node: repo }) => ({
|
const repos = results.map<Project>(({ node: repo }) => ({
|
||||||
name: repo.name,
|
name: repo.name,
|
||||||
url: repo.url,
|
url: repo.url,
|
||||||
description: repo.description as string | undefined,
|
description: repo.description as string,
|
||||||
updatedAt: repo.pushedAt,
|
updatedAt: repo.pushedAt,
|
||||||
stars: repo.stargazerCount,
|
stars: repo.stargazerCount,
|
||||||
forks: repo.forkCount,
|
forks: repo.forkCount,
|
||||||
language: repo.primaryLanguage as Project["language"] | undefined,
|
language: repo.primaryLanguage as Project["language"],
|
||||||
}));
|
}));
|
||||||
|
|
||||||
return {
|
return {
|
||||||
|
@ -2,7 +2,7 @@ import * as config from "../lib/config";
|
|||||||
import { favicons } from "../lib/config/seo";
|
import { favicons } from "../lib/config/seo";
|
||||||
import type { GetServerSideProps } from "next";
|
import type { GetServerSideProps } from "next";
|
||||||
|
|
||||||
export const getServerSideProps: GetServerSideProps = async (context) => {
|
export const getServerSideProps: GetServerSideProps<Record<string, never>> = async (context) => {
|
||||||
const manifest = {
|
const manifest = {
|
||||||
name: config.siteName,
|
name: config.siteName,
|
||||||
short_name: config.siteDomain,
|
short_name: config.siteDomain,
|
||||||
|
@ -4,7 +4,7 @@ import { baseUrl } from "../lib/config";
|
|||||||
import { RELEASE_DATE } from "../lib/config/constants";
|
import { RELEASE_DATE } from "../lib/config/constants";
|
||||||
import type { GetServerSideProps } from "next";
|
import type { GetServerSideProps } from "next";
|
||||||
|
|
||||||
export const getServerSideProps: GetServerSideProps = async (context) => {
|
export const getServerSideProps: GetServerSideProps<Record<string, never>> = async (context) => {
|
||||||
const stream = new SitemapStream({ hostname: baseUrl });
|
const stream = new SitemapStream({ hostname: baseUrl });
|
||||||
|
|
||||||
// TODO: make this not manual (serverless functions can't see filesystem at runtime)
|
// TODO: make this not manual (serverless functions can't see filesystem at runtime)
|
||||||
|
6
types/note.d.ts
vendored
6
types/note.d.ts
vendored
@ -17,5 +17,9 @@ export type NoteWithSource = {
|
|||||||
frontMatter: NoteFrontMatter;
|
frontMatter: NoteFrontMatter;
|
||||||
|
|
||||||
// the final, compiled JSX by next-mdx-remote; see lib/helpers/parse-notes.ts
|
// the final, compiled JSX by next-mdx-remote; see lib/helpers/parse-notes.ts
|
||||||
source: MDXRemoteSerializeResult;
|
source: MDXRemoteSerializeResult<Record<string, never>>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type NotesByYear = {
|
||||||
|
[year: string]: NoteFrontMatter[];
|
||||||
};
|
};
|
||||||
|
Loading…
x
Reference in New Issue
Block a user