gatelogue-types 2.0.0-b8 → 2.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 +59 -0
- package/package.json +5 -3
- package/tsconfig.json +42 -0
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
`gatelogue-types` (python):
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
`gatelogue-types` (rust):
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
`gatelogue-types` (ts, npm):
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
)
|
|
34
|
+
)
|
|
35
|
+
|
|
36
|
+
`gatelogue-types` (ts, jsr):
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
Database of air, rail, sea, bus routes on the MRT
|
|
40
|
+
|
|
41
|
+
Client is hosted at https://mrt-map.github.io/gatelogue
|
|
42
|
+
|
|
43
|
+
Documentation for the aggregator and data format is located at https://mrt-map.github.io/gatelogue/docs
|
|
44
|
+
|
|
45
|
+
## development setup
|
|
46
|
+
if you want to use a github codespace, just open one! setup is handled for you, and will take a few minutes. (it's the green code button, under the codespaces tab)
|
|
47
|
+
|
|
48
|
+
if you'd rather do things locally, the easiest way to get started is with dev containers:
|
|
49
|
+
|
|
50
|
+
1. install docker
|
|
51
|
+
2. install the [remote development pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) for vscode
|
|
52
|
+
3. Use Cmd/Ctrl + Shift + P -> 'Clone Repository in Container Volume' to clone this repo (don't use 'reopen in container', as that will conflict with pnpm)
|
|
53
|
+
4. the container will take a few minutes to install and set up
|
|
54
|
+
|
|
55
|
+
congrats! you did it!
|
|
56
|
+
|
|
57
|
+
run the aggregator with the command `gatelogue-aggregator run`
|
|
58
|
+
|
|
59
|
+
run the client with the command `cd gatelogue-client` and `pnpm run dev`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "gatelogue-types",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.0+8",
|
|
4
4
|
"license": "GPL-3.0-only",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "MRT Mapping Services",
|
|
@@ -29,7 +29,8 @@
|
|
|
29
29
|
"require": "./dist/cjs/lib.js"
|
|
30
30
|
},
|
|
31
31
|
"files": [
|
|
32
|
-
"dist"
|
|
32
|
+
"dist",
|
|
33
|
+
"tsconfig.json"
|
|
33
34
|
],
|
|
34
35
|
"devDependencies": {
|
|
35
36
|
"@eslint/js": "^9.25",
|
|
@@ -47,6 +48,7 @@
|
|
|
47
48
|
"build:cjs": "tsc --outDir dist/cjs -m commonjs --verbatimModuleSyntax false",
|
|
48
49
|
"lint": "eslint --fix lib.ts",
|
|
49
50
|
"format": "prettier --write .",
|
|
50
|
-
"doc": "typedoc"
|
|
51
|
+
"doc": "typedoc",
|
|
52
|
+
"prepublish": "cp ../README.md ."
|
|
51
53
|
}
|
|
52
54
|
}
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/* https://www.totaltypescript.com/tsconfig-cheat-sheet */
|
|
2
|
+
{
|
|
3
|
+
"include": ["lib.ts"],
|
|
4
|
+
"compilerOptions": {
|
|
5
|
+
/* Base Options: */
|
|
6
|
+
"esModuleInterop": true,
|
|
7
|
+
"skipLibCheck": true,
|
|
8
|
+
"target": "esnext",
|
|
9
|
+
"allowJs": true,
|
|
10
|
+
"resolveJsonModule": true,
|
|
11
|
+
"moduleDetection": "force",
|
|
12
|
+
"isolatedModules": true,
|
|
13
|
+
"verbatimModuleSyntax": true,
|
|
14
|
+
|
|
15
|
+
/* Strictness */
|
|
16
|
+
"strict": true,
|
|
17
|
+
"noUncheckedIndexedAccess": true,
|
|
18
|
+
"noImplicitOverride": true,
|
|
19
|
+
|
|
20
|
+
/* If transpiling with TypeScript: */
|
|
21
|
+
"module": "NodeNext",
|
|
22
|
+
"outDir": "dist",
|
|
23
|
+
"sourceMap": true,
|
|
24
|
+
|
|
25
|
+
/* AND if you're building for a library: */
|
|
26
|
+
"declaration": true,
|
|
27
|
+
|
|
28
|
+
/* AND if you're building for a library in a monorepo: */
|
|
29
|
+
"composite": true,
|
|
30
|
+
"declarationMap": true,
|
|
31
|
+
|
|
32
|
+
/* If NOT transpiling with TypeScript:
|
|
33
|
+
"module": "preserve",
|
|
34
|
+
"noEmit": true, */
|
|
35
|
+
|
|
36
|
+
/* If your code runs in the DOM: */
|
|
37
|
+
"lib": ["esnext", "dom", "dom.iterable"]
|
|
38
|
+
|
|
39
|
+
/* If your code doesn't run in the DOM:
|
|
40
|
+
"lib": ["es2022"], */
|
|
41
|
+
}
|
|
42
|
+
}
|