@robot-inventor/shell-session-syntax 1.0.0 → 1.0.2

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.
Files changed (4) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +10 -3
  3. package/package.json +43 -38
  4. package/syntaxes/shell-session.tmLanguage.json +2378 -2378
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2024 ろぼいん
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2024 ろぼいん
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -23,11 +23,18 @@ This project automatically generates the grammar file. It uses [better-shell-syn
23
23
 
24
24
  ## Usage
25
25
 
26
- To use shell-session-syntax in Shiki, please download ``./syntaxes/shell-session.tmLanguage.json`` and load it as a custom language grammar. It automatically overwrites the default ``shellsession`` grammar.
26
+ To use shell-session-syntax in Shiki, please download ``./syntaxes/shell-session.tmLanguage.json`` or install the package and load it as a custom language grammar. It automatically overwrites the default ``shellsession`` grammar.
27
27
 
28
- ```javascript
28
+ ```bash
29
+ npm install @robot-inventor/shell-session-syntax
30
+ ```
31
+
32
+ ```typescript
29
33
  import { getHighlighter } from "shiki";
30
- import shellSession from "./shell-session.tmLanguage.json" assert { type: "json" };
34
+ // Directly import the downloaded file.
35
+ import shellSession from "./shell-session.tmLanguage.json";
36
+ // Or import the package.
37
+ import shellSession from "@robot-inventor/shell-session-syntax";
31
38
 
32
39
  const code = `
33
40
  user@foo$ echo "Hello, World!" > hello.txt
package/package.json CHANGED
@@ -1,38 +1,43 @@
1
- {
2
- "name": "@robot-inventor/shell-session-syntax",
3
- "version": "1.0.0",
4
- "description": "Grammar files for better syntax highlight of Shell Session.",
5
- "main": "dist/index.js",
6
- "types": "dist/index.d.ts",
7
- "type": "module",
8
- "files": [
9
- "dist",
10
- "syntaxes"
11
- ],
12
- "scripts": {
13
- "test": "echo \"Error: no test specified\" && exit 1",
14
- "build": "ts-node ./scripts/generate.ts && tsc"
15
- },
16
- "publishConfig": {
17
- "access": "public"
18
- },
19
- "repository": {
20
- "type": "git",
21
- "url": "git+https://github.com/Robot-Inventor/shell-session-syntax.git"
22
- },
23
- "author": "Robot-Inventor",
24
- "license": "MIT",
25
- "bugs": {
26
- "url": "https://github.com/Robot-Inventor/shell-session-syntax/issues"
27
- },
28
- "homepage": "https://github.com/Robot-Inventor/shell-session-syntax#readme",
29
- "devDependencies": {
30
- "rss-parser": "^3.13.0",
31
- "tar": "^7.0.0",
32
- "ts-node": "^10.9.2",
33
- "typescript": "^5.4.2"
34
- },
35
- "dependencies": {
36
- "shiki": "^1.3.0"
37
- }
38
- }
1
+ {
2
+ "name": "@robot-inventor/shell-session-syntax",
3
+ "version": "1.0.2",
4
+ "description": "Grammar files for better syntax highlight of Shell Session.",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "type": "module",
8
+ "files": [
9
+ "dist",
10
+ "syntaxes"
11
+ ],
12
+ "scripts": {
13
+ "test": "echo \"Error: no test specified\" && exit 1",
14
+ "build": "ts-node ./scripts/generate.ts && tsc",
15
+ "ci:version": "changeset version",
16
+ "ci:publish": "tsc && changeset publish"
17
+ },
18
+ "publishConfig": {
19
+ "access": "public",
20
+ "provenance": true
21
+ },
22
+ "repository": {
23
+ "type": "git",
24
+ "url": "git+https://github.com/Robot-Inventor/shell-session-syntax.git"
25
+ },
26
+ "author": "Robot-Inventor",
27
+ "license": "MIT",
28
+ "bugs": {
29
+ "url": "https://github.com/Robot-Inventor/shell-session-syntax/issues"
30
+ },
31
+ "homepage": "https://github.com/Robot-Inventor/shell-session-syntax#readme",
32
+ "devDependencies": {
33
+ "@changesets/changelog-github": "^0.5.0",
34
+ "@changesets/cli": "^2.27.1",
35
+ "rss-parser": "^3.13.0",
36
+ "tar": "^7.0.0",
37
+ "ts-node": "^10.9.2",
38
+ "typescript": "^5.4.2"
39
+ },
40
+ "dependencies": {
41
+ "shiki": "^1.3.0"
42
+ }
43
+ }