create-substrat 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/index.js +39 -0
- package/package.json +34 -0
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# create-substrat
|
|
2
|
+
|
|
3
|
+
Reserves `npm create substrat` for the Substrat initializer.
|
|
4
|
+
|
|
5
|
+
**The initializer is not released yet.** This package prints a pointer to the docs and
|
|
6
|
+
exits. It does not scaffold anything, because a stub that pretended to would be worse than
|
|
7
|
+
nothing.
|
|
8
|
+
|
|
9
|
+
To start a vertical today, follow the [getting started guide](https://substrat.ahlstrand.es/guide/getting-started).
|
|
10
|
+
The packages are published and usable:
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
pnpm add @substrat-run/kernel @substrat-run/contracts @substrat-run/adapter-sqlite zod
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Note on the name
|
|
17
|
+
|
|
18
|
+
`substrat` on npm is an **unrelated** package — an HTML5 build system published in 2013.
|
|
19
|
+
Substrat's own packages are all under the [`@substrat-run`](https://www.npmjs.com/org/substrat-run)
|
|
20
|
+
scope. Never `npm install substrat`.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
[Docs](https://substrat.ahlstrand.es) · [Repo](https://github.com/substrat-run/substrat) ·
|
|
25
|
+
Apache-2.0
|
package/index.js
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* `npm create substrat` — placeholder.
|
|
4
|
+
*
|
|
5
|
+
* This reserves the entry point a user will guess. It deliberately does nothing
|
|
6
|
+
* but point at what does exist: publishing a stub that pretends to scaffold
|
|
7
|
+
* would be worse than publishing nothing.
|
|
8
|
+
*
|
|
9
|
+
* Dependency-free and buildless on purpose — a placeholder that can break at
|
|
10
|
+
* install time is a placeholder that damages the name it exists to protect.
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
const DOCS = 'https://substrat.ahlstrand.es';
|
|
14
|
+
const GUIDE = `${DOCS}/guide/getting-started`;
|
|
15
|
+
const REPO = 'https://github.com/substrat-run/substrat';
|
|
16
|
+
|
|
17
|
+
process.stdout.write(
|
|
18
|
+
[
|
|
19
|
+
'',
|
|
20
|
+
' Substrat — a hosted substrate for vertical business software.',
|
|
21
|
+
'',
|
|
22
|
+
' The initializer is not released yet. This package reserves',
|
|
23
|
+
' `npm create substrat` for it.',
|
|
24
|
+
'',
|
|
25
|
+
' To start a vertical today, follow the guide:',
|
|
26
|
+
` ${GUIDE}`,
|
|
27
|
+
'',
|
|
28
|
+
' The packages are published and usable now:',
|
|
29
|
+
' pnpm add @substrat-run/kernel @substrat-run/contracts @substrat-run/adapter-sqlite zod',
|
|
30
|
+
'',
|
|
31
|
+
` Docs: ${DOCS}`,
|
|
32
|
+
` Repo: ${REPO}`,
|
|
33
|
+
'',
|
|
34
|
+
' Substrat is 0.x and interfaces change without notice until the first',
|
|
35
|
+
' vertical ships.',
|
|
36
|
+
'',
|
|
37
|
+
'',
|
|
38
|
+
].join('\n'),
|
|
39
|
+
);
|
package/package.json
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "create-substrat",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "Scaffold a Substrat vertical — `npm create substrat`. Placeholder reserving the entry point; the initializer is not released yet.",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/substrat-run/substrat.git",
|
|
9
|
+
"directory": "packages/create-substrat"
|
|
10
|
+
},
|
|
11
|
+
"homepage": "https://substrat.ahlstrand.es",
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/substrat-run/substrat/issues"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"substrat",
|
|
17
|
+
"vertical",
|
|
18
|
+
"multi-tenant",
|
|
19
|
+
"scaffold"
|
|
20
|
+
],
|
|
21
|
+
"type": "module",
|
|
22
|
+
"bin": {
|
|
23
|
+
"create-substrat": "./index.js"
|
|
24
|
+
},
|
|
25
|
+
"files": [
|
|
26
|
+
"index.js"
|
|
27
|
+
],
|
|
28
|
+
"engines": {
|
|
29
|
+
"node": ">=20"
|
|
30
|
+
},
|
|
31
|
+
"publishConfig": {
|
|
32
|
+
"access": "public"
|
|
33
|
+
}
|
|
34
|
+
}
|