schema-sentry-vscode 0.9.1
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/LICENSE +21 -0
- package/README.md +86 -0
- package/package.json +122 -0
- package/schema-sentry-snippets.gif +0 -0
- package/snippets/schema-sentry.json +240 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Schema Sentry
|
|
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
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# 🛡️ Schema Sentry - VS Code Extension
|
|
2
|
+
|
|
3
|
+
**Type-safe JSON-LD structured data helpers for VS Code.**
|
|
4
|
+
|
|
5
|
+
Boost your SEO and AI discoverability with Schema Sentry's VS Code extension. Get real-time schema preview, snippets, and validation while you code.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## ✨ Features
|
|
14
|
+
|
|
15
|
+
### 🔌 Snippets
|
|
16
|
+
Type `schema-` in any `.tsx` file to see autocomplete suggestions:
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
| Snippet | Schema Type |
|
|
21
|
+
|---------|-------------|
|
|
22
|
+
| `schema-organization` | Organization |
|
|
23
|
+
| `schema-person` | Person |
|
|
24
|
+
| `schema-article` | Article |
|
|
25
|
+
| `schema-blogposting` | BlogPosting |
|
|
26
|
+
| `schema-product` | Product |
|
|
27
|
+
| `schema-faq` | FAQPage |
|
|
28
|
+
| `schema-howto` | HowTo |
|
|
29
|
+
| `schema-event` | Event |
|
|
30
|
+
| `schema-localbusiness` | LocalBusiness |
|
|
31
|
+
| `schema-website` | WebSite |
|
|
32
|
+
| `schema-breadcrumb` | BreadcrumbList |
|
|
33
|
+
| `schema-review` | Review |
|
|
34
|
+
| `schema-video` | VideoObject |
|
|
35
|
+
| `schema-image` | ImageObject |
|
|
36
|
+
|
|
37
|
+
### 👁️ Preview Panel
|
|
38
|
+
- Click the **status bar** item or run `Schema Sentry: Preview Schema`
|
|
39
|
+
- See all schema types detected in your file
|
|
40
|
+
- Real-time feedback as you code
|
|
41
|
+
|
|
42
|
+
### 🎯 Commands
|
|
43
|
+
|
|
44
|
+
| Command | Description |
|
|
45
|
+
|---------|-------------|
|
|
46
|
+
| `Schema Sentry: Preview Schema` | 👁️ Open preview panel |
|
|
47
|
+
| `Schema Sentry: Add Schema Type` | ➕ Insert schema snippet |
|
|
48
|
+
| `Schema Sentry: Validate File` | ✅ Show validation issues |
|
|
49
|
+
|
|
50
|
+
### 🏷️ Inline Decorations
|
|
51
|
+
Schema type badges appear in the gutter as you type — always know what schema you're adding!
|
|
52
|
+
|
|
53
|
+
### ⚙️ Settings
|
|
54
|
+
|
|
55
|
+
| Setting | Default | Description |
|
|
56
|
+
|---------|---------|-------------|
|
|
57
|
+
| `schemasentry.enablePreview` | `true` | Show preview panel |
|
|
58
|
+
| `schemasentry.enableDecorations` | `true` | Show gutter badges |
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## 🚀 Quick Start
|
|
63
|
+
|
|
64
|
+
1. **Install**: `code --install-extension schema-sentry-vscode-0.9.0.vsix`
|
|
65
|
+
2. **Open** a Next.js `.tsx` file
|
|
66
|
+
3. **Type** `schema-` to see snippets, or click the 🛡️ status bar item
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## 📋 Requirements
|
|
71
|
+
|
|
72
|
+
- VS Code 1.99.0+
|
|
73
|
+
- TypeScript/TSX or JavaScript/JSX files
|
|
74
|
+
- Works best with `@schemasentry/next` package
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## 🔗 Links
|
|
79
|
+
|
|
80
|
+
- [Main Documentation](https://github.com/arindamdawn/schema-sentry)
|
|
81
|
+
- [NPM Packages](https://www.npmjs.com/org/schemasentry)
|
|
82
|
+
- [Report Issues](https://github.com/arindamdawn/schema-sentry/issues)
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
**Made with ❤️ for better SEO & AI discoverability!**
|
package/package.json
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "schema-sentry-vscode",
|
|
3
|
+
"version": "0.9.1",
|
|
4
|
+
"description": "VS Code extension for Schema Sentry - preview panel, snippets, and inline decorations.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"publisher": "ArindamDawn",
|
|
7
|
+
"type": "module",
|
|
8
|
+
"main": "./dist/extension.js",
|
|
9
|
+
"engines": {
|
|
10
|
+
"vscode": "^1.99.0"
|
|
11
|
+
},
|
|
12
|
+
"activationEvents": [
|
|
13
|
+
"onStartupFinished",
|
|
14
|
+
"onLanguage:typescript",
|
|
15
|
+
"onLanguage:typescriptreact",
|
|
16
|
+
"onLanguage:javascript",
|
|
17
|
+
"onLanguage:javascriptreact"
|
|
18
|
+
],
|
|
19
|
+
"contributes": {
|
|
20
|
+
"commands": [
|
|
21
|
+
{
|
|
22
|
+
"command": "schemasentry.preview",
|
|
23
|
+
"title": "Schema Sentry: Preview Schema"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"command": "schemasentry.addSchema",
|
|
27
|
+
"title": "Schema Sentry: Add Schema Type"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"command": "schemasentry.validate",
|
|
31
|
+
"title": "Schema Sentry: Validate File"
|
|
32
|
+
}
|
|
33
|
+
],
|
|
34
|
+
"menus": {
|
|
35
|
+
"editor/context": [
|
|
36
|
+
{
|
|
37
|
+
"command": "schemasentry.preview",
|
|
38
|
+
"when": "editorHasSelection",
|
|
39
|
+
"group": "navigation"
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"command": "schemasentry.addSchema",
|
|
43
|
+
"when": "editorHasSelection",
|
|
44
|
+
"group": "navigation"
|
|
45
|
+
}
|
|
46
|
+
],
|
|
47
|
+
"commandPalette": [
|
|
48
|
+
{
|
|
49
|
+
"command": "schemasentry.preview"
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"command": "schemasentry.addSchema"
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"command": "schemasentry.validate"
|
|
56
|
+
}
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
"snippets": [
|
|
60
|
+
{
|
|
61
|
+
"language": "typescriptreact",
|
|
62
|
+
"path": "./snippets/schema-sentry.json"
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"language": "javascriptreact",
|
|
66
|
+
"path": "./snippets/schema-sentry.json"
|
|
67
|
+
}
|
|
68
|
+
],
|
|
69
|
+
"configuration": {
|
|
70
|
+
"title": "Schema Sentry",
|
|
71
|
+
"properties": {
|
|
72
|
+
"schemasentry.enablePreview": {
|
|
73
|
+
"type": "boolean",
|
|
74
|
+
"default": true,
|
|
75
|
+
"description": "Enable schema preview panel"
|
|
76
|
+
},
|
|
77
|
+
"schemasentry.enableDecorations": {
|
|
78
|
+
"type": "boolean",
|
|
79
|
+
"default": true,
|
|
80
|
+
"description": "Show schema type decorations in gutter"
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
},
|
|
85
|
+
"devDependencies": {
|
|
86
|
+
"@types/vscode": "^1.99.0",
|
|
87
|
+
"@types/node": "^22.10.2",
|
|
88
|
+
"typescript": "^5.9.3"
|
|
89
|
+
},
|
|
90
|
+
"repository": {
|
|
91
|
+
"type": "git",
|
|
92
|
+
"url": "https://github.com/arindamdawn/schema-sentry.git",
|
|
93
|
+
"directory": "packages/vscode"
|
|
94
|
+
},
|
|
95
|
+
"bugs": {
|
|
96
|
+
"url": "https://github.com/arindamdawn/schema-sentry/issues"
|
|
97
|
+
},
|
|
98
|
+
"keywords": [
|
|
99
|
+
"schema",
|
|
100
|
+
"json-ld",
|
|
101
|
+
"structured-data",
|
|
102
|
+
"seo",
|
|
103
|
+
"vscode",
|
|
104
|
+
"extension"
|
|
105
|
+
],
|
|
106
|
+
"publishConfig": {
|
|
107
|
+
"access": "public"
|
|
108
|
+
},
|
|
109
|
+
"files": [
|
|
110
|
+
"dist",
|
|
111
|
+
"snippets",
|
|
112
|
+
"README.md",
|
|
113
|
+
"LICENSE",
|
|
114
|
+
"schema-sentry-snippets.gif"
|
|
115
|
+
],
|
|
116
|
+
"scripts": {
|
|
117
|
+
"vscode:prepublish": "npm run compile",
|
|
118
|
+
"compile": "tsc -p ./",
|
|
119
|
+
"watch": "tsc -watch -p ./",
|
|
120
|
+
"test": "echo \"No tests yet\" && exit 0"
|
|
121
|
+
}
|
|
122
|
+
}
|
|
Binary file
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
{
|
|
2
|
+
"Schema - Organization": {
|
|
3
|
+
"prefix": "schema-organization",
|
|
4
|
+
"body": [
|
|
5
|
+
"import { Schema, Organization } from '@schemasentry/next';",
|
|
6
|
+
"",
|
|
7
|
+
"const org = Organization({",
|
|
8
|
+
" name: '$1',",
|
|
9
|
+
" url: '$2',",
|
|
10
|
+
" logo: '$3',",
|
|
11
|
+
"});",
|
|
12
|
+
"",
|
|
13
|
+
"export default function OrganizationSchema() {",
|
|
14
|
+
" return <Schema data={org} />;",
|
|
15
|
+
"}"
|
|
16
|
+
],
|
|
17
|
+
"description": "Add Organization schema"
|
|
18
|
+
},
|
|
19
|
+
"Schema - Person": {
|
|
20
|
+
"prefix": "schema-person",
|
|
21
|
+
"body": [
|
|
22
|
+
"import { Schema, Person } from '@schemasentry/next';",
|
|
23
|
+
"",
|
|
24
|
+
"const person = Person({",
|
|
25
|
+
" name: '$1',",
|
|
26
|
+
" url: '$2',",
|
|
27
|
+
"});",
|
|
28
|
+
"",
|
|
29
|
+
"export default function PersonSchema() {",
|
|
30
|
+
" return <Schema data={person} />;",
|
|
31
|
+
"}"
|
|
32
|
+
],
|
|
33
|
+
"description": "Add Person schema"
|
|
34
|
+
},
|
|
35
|
+
"Schema - Article": {
|
|
36
|
+
"prefix": "schema-article",
|
|
37
|
+
"body": [
|
|
38
|
+
"import { Schema, Article } from '@schemasentry/next';",
|
|
39
|
+
"",
|
|
40
|
+
"const article = Article({",
|
|
41
|
+
" headline: '$1',",
|
|
42
|
+
" authorName: '$2',",
|
|
43
|
+
" datePublished: '$3',",
|
|
44
|
+
" url: '$4',",
|
|
45
|
+
"});",
|
|
46
|
+
"",
|
|
47
|
+
"export default function ArticleSchema() {",
|
|
48
|
+
" return <Schema data={article} />;",
|
|
49
|
+
"}"
|
|
50
|
+
],
|
|
51
|
+
"description": "Add Article schema"
|
|
52
|
+
},
|
|
53
|
+
"Schema - BlogPosting": {
|
|
54
|
+
"prefix": "schema-blogposting",
|
|
55
|
+
"body": [
|
|
56
|
+
"import { Schema, BlogPosting } from '@schemasentry/next';",
|
|
57
|
+
"",
|
|
58
|
+
"const blogPosting = BlogPosting({",
|
|
59
|
+
" headline: '$1',",
|
|
60
|
+
" authorName: '$2',",
|
|
61
|
+
" datePublished: '$3',",
|
|
62
|
+
" url: '$4',",
|
|
63
|
+
"});",
|
|
64
|
+
"",
|
|
65
|
+
"export default function BlogPostingSchema() {",
|
|
66
|
+
" return <Schema data={blogPosting} />;",
|
|
67
|
+
"}"
|
|
68
|
+
],
|
|
69
|
+
"description": "Add BlogPosting schema"
|
|
70
|
+
},
|
|
71
|
+
"Schema - Product": {
|
|
72
|
+
"prefix": "schema-product",
|
|
73
|
+
"body": [
|
|
74
|
+
"import { Schema, Product } from '@schemasentry/next';",
|
|
75
|
+
"",
|
|
76
|
+
"const product = Product({",
|
|
77
|
+
" name: '$1',",
|
|
78
|
+
" description: '$2',",
|
|
79
|
+
" url: '$3',",
|
|
80
|
+
"});",
|
|
81
|
+
"",
|
|
82
|
+
"export default function ProductSchema() {",
|
|
83
|
+
" return <Schema data={product} />;",
|
|
84
|
+
"}"
|
|
85
|
+
],
|
|
86
|
+
"description": "Add Product schema"
|
|
87
|
+
},
|
|
88
|
+
"Schema - FAQPage": {
|
|
89
|
+
"prefix": "schema-faq",
|
|
90
|
+
"body": [
|
|
91
|
+
"import { Schema, FAQPage } from '@schemasentry/next';",
|
|
92
|
+
"",
|
|
93
|
+
"const faq = FAQPage({",
|
|
94
|
+
" questions: [",
|
|
95
|
+
" { question: '$1', answer: '$2' },",
|
|
96
|
+
" ],",
|
|
97
|
+
"});",
|
|
98
|
+
"",
|
|
99
|
+
"export default function FAQSchema() {",
|
|
100
|
+
" return <Schema data={faq} />;",
|
|
101
|
+
"}"
|
|
102
|
+
],
|
|
103
|
+
"description": "Add FAQPage schema"
|
|
104
|
+
},
|
|
105
|
+
"Schema - HowTo": {
|
|
106
|
+
"prefix": "schema-howto",
|
|
107
|
+
"body": [
|
|
108
|
+
"import { Schema, HowTo } from '@schemasentry/next';",
|
|
109
|
+
"",
|
|
110
|
+
"const howTo = HowTo({",
|
|
111
|
+
" name: '$1',",
|
|
112
|
+
" steps: [",
|
|
113
|
+
" { text: '$2' },",
|
|
114
|
+
" ],",
|
|
115
|
+
"});",
|
|
116
|
+
"",
|
|
117
|
+
"export default function HowToSchema() {",
|
|
118
|
+
" return <Schema data={howTo} />;",
|
|
119
|
+
"}"
|
|
120
|
+
],
|
|
121
|
+
"description": "Add HowTo schema"
|
|
122
|
+
},
|
|
123
|
+
"Schema - Event": {
|
|
124
|
+
"prefix": "schema-event",
|
|
125
|
+
"body": [
|
|
126
|
+
"import { Schema, Event } from '@schemasentry/next';",
|
|
127
|
+
"",
|
|
128
|
+
"const event = Event({",
|
|
129
|
+
" name: '$1',",
|
|
130
|
+
" startDate: '$2',",
|
|
131
|
+
" locationName: '$3',",
|
|
132
|
+
"});",
|
|
133
|
+
"",
|
|
134
|
+
"export default function EventSchema() {",
|
|
135
|
+
" return <Schema data={event} />;",
|
|
136
|
+
"}"
|
|
137
|
+
],
|
|
138
|
+
"description": "Add Event schema"
|
|
139
|
+
},
|
|
140
|
+
"Schema - LocalBusiness": {
|
|
141
|
+
"prefix": "schema-localbusiness",
|
|
142
|
+
"body": [
|
|
143
|
+
"import { Schema, LocalBusiness } from '@schemasentry/next';",
|
|
144
|
+
"",
|
|
145
|
+
"const business = LocalBusiness({",
|
|
146
|
+
" name: '$1',",
|
|
147
|
+
" address: '$2',",
|
|
148
|
+
" telephone: '$3',",
|
|
149
|
+
"});",
|
|
150
|
+
"",
|
|
151
|
+
"export default function LocalBusinessSchema() {",
|
|
152
|
+
" return <Schema data={business} />;",
|
|
153
|
+
"}"
|
|
154
|
+
],
|
|
155
|
+
"description": "Add LocalBusiness schema"
|
|
156
|
+
},
|
|
157
|
+
"Schema - WebSite": {
|
|
158
|
+
"prefix": "schema-website",
|
|
159
|
+
"body": [
|
|
160
|
+
"import { Schema, WebSite } from '@schemasentry/next';",
|
|
161
|
+
"",
|
|
162
|
+
"const website = WebSite({",
|
|
163
|
+
" name: '$1',",
|
|
164
|
+
" url: '$2',",
|
|
165
|
+
"});",
|
|
166
|
+
"",
|
|
167
|
+
"export default function WebSiteSchema() {",
|
|
168
|
+
" return <Schema data={website} />;",
|
|
169
|
+
"}"
|
|
170
|
+
],
|
|
171
|
+
"description": "Add WebSite schema"
|
|
172
|
+
},
|
|
173
|
+
"Schema - BreadcrumbList": {
|
|
174
|
+
"prefix": "schema-breadcrumb",
|
|
175
|
+
"body": [
|
|
176
|
+
"import { Schema, BreadcrumbList } from '@schemasentry/next';",
|
|
177
|
+
"",
|
|
178
|
+
"const breadcrumbs = BreadcrumbList({",
|
|
179
|
+
" items: [",
|
|
180
|
+
" { name: '$1', url: '$2' },",
|
|
181
|
+
" ],",
|
|
182
|
+
"});",
|
|
183
|
+
"",
|
|
184
|
+
"export default function BreadcrumbSchema() {",
|
|
185
|
+
" return <Schema data={breadcrumbs} />;",
|
|
186
|
+
"}"
|
|
187
|
+
],
|
|
188
|
+
"description": "Add BreadcrumbList schema"
|
|
189
|
+
},
|
|
190
|
+
"Schema - VideoObject": {
|
|
191
|
+
"prefix": "schema-video",
|
|
192
|
+
"body": [
|
|
193
|
+
"import { Schema, VideoObject } from '@schemasentry/next';",
|
|
194
|
+
"",
|
|
195
|
+
"const video = VideoObject({",
|
|
196
|
+
" name: '$1',",
|
|
197
|
+
" description: '$2',",
|
|
198
|
+
" thumbnailUrl: '$3',",
|
|
199
|
+
" uploadDate: '$4',",
|
|
200
|
+
"});",
|
|
201
|
+
"",
|
|
202
|
+
"export default function VideoSchema() {",
|
|
203
|
+
" return <Schema data={video} />;",
|
|
204
|
+
"}"
|
|
205
|
+
],
|
|
206
|
+
"description": "Add VideoObject schema"
|
|
207
|
+
},
|
|
208
|
+
"Schema - ImageObject": {
|
|
209
|
+
"prefix": "schema-image",
|
|
210
|
+
"body": [
|
|
211
|
+
"import { Schema, ImageObject } from '@schemasentry/next';",
|
|
212
|
+
"",
|
|
213
|
+
"const image = ImageObject({",
|
|
214
|
+
" contentUrl: '$1',",
|
|
215
|
+
"});",
|
|
216
|
+
"",
|
|
217
|
+
"export default function ImageSchema() {",
|
|
218
|
+
" return <Schema data={image} />;",
|
|
219
|
+
"}"
|
|
220
|
+
],
|
|
221
|
+
"description": "Add ImageObject schema"
|
|
222
|
+
},
|
|
223
|
+
"Schema - Review": {
|
|
224
|
+
"prefix": "schema-review",
|
|
225
|
+
"body": [
|
|
226
|
+
"import { Schema, Review } from '@schemasentry/next';",
|
|
227
|
+
"",
|
|
228
|
+
"const review = Review({",
|
|
229
|
+
" itemName: '$1',",
|
|
230
|
+
" authorName: '$2',",
|
|
231
|
+
" ratingValue: '$3',",
|
|
232
|
+
"});",
|
|
233
|
+
"",
|
|
234
|
+
"export default function ReviewSchema() {",
|
|
235
|
+
" return <Schema data={review} />;",
|
|
236
|
+
"}"
|
|
237
|
+
],
|
|
238
|
+
"description": "Add Review schema"
|
|
239
|
+
}
|
|
240
|
+
}
|