Skip to content

Commit 0ac4c0e

Browse files
committed
Rename @domstack/cli to @domstack/static
1 parent 6b4edf9 commit 0ac4c0e

File tree

21 files changed

+35
-35
lines changed

21 files changed

+35
-35
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# 🪢 DOMStack
2-
[![npm version](https://img.shields.io/npm/v/@domstack/cli.svg)](https://npmjs.org/package/@domstack/cli)
2+
[![npm version](https://img.shields.io/npm/v/@domstack/static.svg)](https://npmjs.org/package/@domstack/static)
33
[![Actions Status](https://github.com/bcomnes/domstack/workflows/tests/badge.svg)](https://github.com/bcomnes/domstack/actions)
44
[![Coverage Status](https://coveralls.io/repos/github/bcomnes/domstack/badge.svg?branch=master)](https://coveralls.io/github/bcomnes/domstack?branch=master)
55
[![Types in JS](https://img.shields.io/badge/types_in_js-yes-brightgreen)](https://github.com/voxpelli/types-in-js)
@@ -12,7 +12,7 @@ DOMStack provides a few project conventions around esbuild ande Node.js that let
1212
It's fast to learn, quick to build with, and performs better than you are used to.
1313

1414
```console
15-
npm install @domstack/cli
15+
npm install @domstack/static
1616
```
1717

1818
- 🌎 [domstack docs website](https://domstack.net)
@@ -237,7 +237,7 @@ src/page-name/page.js
237237
An example TypeScript page:
238238

239239
```typescript
240-
import type { PageFunction } from '@domstack/cli'
240+
import type { PageFunction } from '@domstack/static'
241241

242242
export const vars = {
243243
favoriteCookie: 'Chocolate Chip with Sea Salt'
@@ -260,7 +260,7 @@ It is recommended to use some level of template processing over raw string templ
260260
```typescript
261261
import { html } from 'htm/preact'
262262
import { dirname, basename } from 'node:path'
263-
import type { PageFunction } from '@domstack/cli'
263+
import type { PageFunction } from '@domstack/static'
264264

265265
type BlogVars = {
266266
favoriteCake: string
@@ -465,7 +465,7 @@ The default `root.layout.ts` is featured below, and is implemented with [`preact
465465
```typescript
466466
import { html } from 'htm/preact'
467467
import { render } from 'preact-render-to-string'
468-
import type { LayoutFunction } from '@domstack/cli'
468+
import type { LayoutFunction } from '@domstack/static'
469469

470470
type RootLayoutVars = {
471471
title: string,
@@ -528,7 +528,7 @@ For example, you could define a `blog.layout.ts` that re-uses the `root.layout.t
528528
import defaultRootLayout from './root.layout.js'
529529
import { html } from 'htm/preact'
530530
import { render } from 'preact-render-to-string'
531-
import type { LayoutFunction } from '@domstack/cli'
531+
import type { LayoutFunction } from '@domstack/static'
532532

533533
// Import the type from root layout
534534
import type { RootLayoutVars } from './root.layout'
@@ -727,7 +727,7 @@ A function that returns a string. The `name-of-template.txt` portion of the temp
727727

728728
```typescript
729729
// name-of-template.txt.template.ts
730-
import type { TemplateFunction } from '@domstack/cli'
730+
import type { TemplateFunction } from '@domstack/static'
731731

732732
interface TemplateVars {
733733
foo: string;
@@ -751,7 +751,7 @@ This is just a file with access to global vars: ${foo}`
751751
A function that returns a single object with a `content` and `outputName` entries. The `outputName` overrides the name portion of the template file name.
752752

753753
```typescript
754-
import type { TemplateFunction } from '@domstack/cli'
754+
import type { TemplateFunction } from '@domstack/static'
755755

756756
interface TemplateVars {
757757
foo: string;
@@ -771,7 +771,7 @@ This is just a file with access to global vars: ${foo}`,
771771
A function that returns an array of objects with a `content` and `outputName` entries. This template file generates more than one file from a single template file.
772772

773773
```typescript
774-
import type { TemplateFunction } from '@domstack/cli'
774+
import type { TemplateFunction } from '@domstack/static'
775775

776776
interface TemplateVars {
777777
foo: string;
@@ -806,7 +806,7 @@ This is just a file with access to global vars: ${testVar}`,
806806
An [AsyncIterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator) that `yields` objects with `content` and `outputName` entries.
807807

808808
```typescript
809-
import type { TemplateAsyncIterator } from '@domstack/cli'
809+
import type { TemplateAsyncIterator } from '@domstack/static'
810810

811811
interface TemplateVars {
812812
foo: string;
@@ -846,7 +846,7 @@ The following example shows how to generate an [RSS](https://www.rssboard.org) a
846846
```typescript
847847
import pMap from 'p-map'
848848
import jsonfeedToAtom from 'jsonfeed-to-atom'
849-
import type { TemplateAsyncIterator } from '@domstack/cli'
849+
import type { TemplateAsyncIterator } from '@domstack/static'
850850

851851
interface TemplateVars {
852852
title: string;
@@ -965,7 +965,7 @@ Here is an example of using this file to polyfill node builtins in the browser b
965965
```typescript
966966
import { polyfillNode } from 'esbuild-plugin-polyfill-node'
967967
// BuildOptions re-exported from esbuild
968-
import type { BuildOptions } from '@domstack/cli'
968+
import type { BuildOptions } from '@domstack/static'
969969

970970
export default const esbuildSettingsOverride = async (esbuildSettings: BuildOptions): Promise<BuildOptions> => {
971971
esbuildSettings.plugins = [polyfillNode()]
@@ -1082,7 +1082,7 @@ For example:
10821082
```typescript
10831083
import { html } from 'htm/preact'
10841084
import { render } from 'preact-render-to-string'
1085-
import type { PostVarsFunction } from '@domstack/cli'
1085+
import type { PostVarsFunction } from '@domstack/static'
10861086

10871087
export const postVars: PostVarsFunction = async ({
10881088
pages
@@ -1178,7 +1178,7 @@ import type {
11781178
PageFunction,
11791179
TemplateFunction,
11801180
TemplateAsyncIterator
1181-
} from '@domstack/cli'
1181+
} from '@domstack/static'
11821182
```
11831183

11841184
They are all generic and accept a variable template that you can develop and share between files.

examples/basic/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"@voxpelli/tsconfig": "^15.0.0"
2020
},
2121
"dependencies": {
22-
"@domstack/cli": "file:../../.",
22+
"@domstack/static": "file:../../.",
2323
"htm": "^3.1.1",
2424
"preact": "^10.26.6",
2525
"preact-render-to-string": "^6.5.13",

examples/basic/src/js-page/loose-assets/page.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { html } from 'htm/preact'
2-
import type { PageFunction } from '@domstack/cli'
2+
import type { PageFunction } from '@domstack/static'
33

44
import sharedData from './shared-lib.js'
55
import type { PageVars } from '../../layouts/root.layout.ts'

examples/basic/src/js-page/page.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* @import { PageFunction } from '@domstack/cli'
2+
* @import { PageFunction } from '@domstack/static'
33
* @import { PageVars } from '../layouts/root.layout.js
44
*/
55
import { html } from 'htm/preact'

examples/basic/src/layouts/child.layout.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type { LayoutFunction } from '@domstack/cli'
1+
import type { LayoutFunction } from '@domstack/static'
22
import { html } from 'htm/preact'
33
import { render } from 'preact-render-to-string'
44

examples/basic/src/layouts/root.layout.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
import { html } from 'htm/preact'
1111
import { render } from 'preact-render-to-string'
12-
import type { LayoutFunction } from '@domstack/cli'
12+
import type { LayoutFunction } from '@domstack/static'
1313

1414
export interface PageVars {
1515
title: string;

examples/css-modules/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"mine.css": "^9.0.1",
1818
"preact": "^10.24.0",
1919
"preact-render-to-string": "^6.5.11",
20-
"@domstack/cli": "file:../../."
20+
"@domstack/static": "file:../../."
2121
},
2222
"devDependencies": {
2323
"npm-run-all2": "^6.0.0"

examples/css-modules/src/layouts/root.layout.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* @import { LayoutFunction } from '@domstack/cli'
2+
* @import { LayoutFunction } from '@domstack/static'
33
*/
44

55
import { html } from 'htm/preact'

examples/default-layout/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"watch:domstack": "npm run build -- --watch"
1313
},
1414
"dependencies": {
15-
"@domstack/cli": "file:../../."
15+
"@domstack/static": "file:../../."
1616
},
1717
"devDependencies": {
1818
"browser-sync": "^2.26.7",

examples/esbuild-settings/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"author": "Bret Comnes <[email protected]> (https://bret.io/)",
1212
"license": "MIT",
1313
"dependencies": {
14-
"@domstack/cli": "file:../../."
14+
"@domstack/static": "file:../../."
1515
},
1616
"devDependencies": {
1717
"esbuild-plugin-polyfill-node": "^0.3.0",

0 commit comments

Comments
 (0)