Skip to content

Commit

Permalink
feat: switch from tsup/builds to Remix/website
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg committed Feb 20, 2024
1 parent b30db11 commit e472eda
Show file tree
Hide file tree
Showing 11 changed files with 3,250 additions and 377 deletions.
10 changes: 9 additions & 1 deletion .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@ module.exports = {
"plugin:perfectionist/recommended-natural",
"plugin:regexp/recommended",
],
ignorePatterns: ["!.*", "lib", "node_modules", "pnpm-lock.yaml"],
ignorePatterns: [
"!.*",
".cache",
"build",
"public",
"node_modules",
"pnpm-lock.yaml",
],
overrides: [
{
extends: ["plugin:markdown/recommended"],
Expand Down Expand Up @@ -128,6 +135,7 @@ module.exports = {
"@typescript-eslint/no-unused-vars": ["error", { caughtErrors: "all" }],

// These on-by-default rules don't work well for this repo and we like them off.
"n/no-unpublished-import": "off",
"no-case-declarations": "off",
"no-constant-condition": "off",
"no-inner-declarations": "off",
Expand Down
12 changes: 3 additions & 9 deletions .github/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,12 @@ pnpm install
> This repository includes a list of suggested VS Code extensions.
> It's a good idea to use [VS Code](https://code.visualstudio.com) and accept its suggestion to install them, as they'll help with development.
## Building
## Dev

Run [**tsup**](https://tsup.egoist.dev) locally to build source files from `src/` into output files in `lib/`:
Run the [**Remix**](https://remix.run/docs/en/main/start/quickstart) quickstart dev server locally to preview the website:

```shell
pnpm build
```

Add `--watch` to run the builder in a watch mode that continuously cleans and recreates `lib/` as you save files:

```shell
pnpm build --watch
pnpm dev
```

## Formatting
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
lib/
.cache/
build/
public/
node_modules/
4 changes: 3 additions & 1 deletion .markdownlintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
.github/CODE_OF_CONDUCT.md
CHANGELOG.md
lib/
.cache/
build/
public/
node_modules/
4 changes: 3 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.all-contributorsrc
lib/
.cache/
build/
public/
pnpm-lock.yaml
20 changes: 20 additions & 0 deletions app/root.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { Links, LiveReload, Meta, Outlet, Scripts } from "@remix-run/react";

export default function App() {
return (
<html>
<head>
<link href="data:image/x-icon;base64,AA" rel="icon" />
<Meta />
<Links />
</head>
<body>
<h1>Hello world!</h1>
<Outlet />

<Scripts />
<LiveReload />
</body>
</html>
);
}
6 changes: 4 additions & 2 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
"ignorePaths": [
".github",
"CHANGELOG.md",
"lib",
".cache",
"build",
"public",
"node_modules",
"pnpm-lock.yaml"
],
"words": ["knip", "packagejson", "tsup"]
"words": ["isbot", "knip", "packagejson"]
}
21 changes: 12 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,12 @@
"repository": "JoshuaKGoldberg/boston-ts-website",
"license": "MIT",
"author": {
"name": "Josh Goldberg",
"email": "npm@joshuakgoldberg.com"
},
"type": "module",
"main": "./lib/index.js",
"files": [
"lib/",
"package.json",
"LICENSE.md",
"README.md"
],
"scripts": {
"build": "tsup",
"dev": "remix dev -c \"node server.js\"",
"format": "prettier .",
"lint": "eslint . .*js --max-warnings 0",
"lint:knip": "knip",
Expand All @@ -29,6 +23,16 @@
"lint-staged": {
"*": "prettier --ignore-unknown --write"
},
"dependencies": {
"@remix-run/dev": "^2.6.0",
"@remix-run/express": "^2.6.0",
"@remix-run/node": "^2.6.0",
"@remix-run/react": "^2.6.0",
"express": "^4.18.2",
"isbot": "4",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@types/eslint": "^8.56.2",
"@typescript-eslint/eslint-plugin": "^7.0.2",
Expand All @@ -55,7 +59,6 @@
"prettier-plugin-curly": "^0.1.4",
"prettier-plugin-packagejson": "^2.4.11",
"sentences-per-line": "^0.2.1",
"tsup": "^8.0.2",
"typescript": "^5.3.3",
"yaml-eslint-parser": "^1.2.2"
},
Expand Down
Loading

0 comments on commit e472eda

Please sign in to comment.