Skip to content

Commit 7c482ec

Browse files
yamachuyamachu
committed
Update documents, LICENSE
1 parent 75fd884 commit 7c482ec

File tree

6 files changed

+246
-114
lines changed

6 files changed

+246
-114
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
All notable changes to the "workflow-script-highlighter" extension will be documented in this file.
44

5-
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
6-
7-
## [Unreleased]
5+
## [v0.0.1]
86

97
- Initial release

‎LICENSE‎

Lines changed: 227 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,227 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Yusuke Yamada
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.
22+
23+
---
24+
25+
https://github.com/typescript-language-server/typescript-language-server/blob/master/LICENSE
26+
27+
Apache License
28+
Version 2.0, January 2004
29+
http://www.apache.org/licenses/
30+
31+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
32+
33+
1. Definitions.
34+
35+
"License" shall mean the terms and conditions for use, reproduction,
36+
and distribution as defined by Sections 1 through 9 of this document.
37+
38+
"Licensor" shall mean the copyright owner or entity authorized by
39+
the copyright owner that is granting the License.
40+
41+
"Legal Entity" shall mean the union of the acting entity and all
42+
other entities that control, are controlled by, or are under common
43+
control with that entity. For the purposes of this definition,
44+
"control" means (i) the power, direct or indirect, to cause the
45+
direction or management of such entity, whether by contract or
46+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
47+
outstanding shares, or (iii) beneficial ownership of such entity.
48+
49+
"You" (or "Your") shall mean an individual or Legal Entity
50+
exercising permissions granted by this License.
51+
52+
"Source" form shall mean the preferred form for making modifications,
53+
including but not limited to software source code, documentation
54+
source, and configuration files.
55+
56+
"Object" form shall mean any form resulting from mechanical
57+
transformation or translation of a Source form, including but
58+
not limited to compiled object code, generated documentation,
59+
and conversions to other media types.
60+
61+
"Work" shall mean the work of authorship, whether in Source or
62+
Object form, made available under the License, as indicated by a
63+
copyright notice that is included in or attached to the work
64+
(an example is provided in the Appendix below).
65+
66+
"Derivative Works" shall mean any work, whether in Source or Object
67+
form, that is based on (or derived from) the Work and for which the
68+
editorial revisions, annotations, elaborations, or other modifications
69+
represent, as a whole, an original work of authorship. For the purposes
70+
of this License, Derivative Works shall not include works that remain
71+
separable from, or merely link (or bind by name) to the interfaces of,
72+
the Work and Derivative Works thereof.
73+
74+
"Contribution" shall mean any work of authorship, including
75+
the original version of the Work and any modifications or additions
76+
to that Work or Derivative Works thereof, that is intentionally
77+
submitted to Licensor for inclusion in the Work by the copyright owner
78+
or by an individual or Legal Entity authorized to submit on behalf of
79+
the copyright owner. For the purposes of this definition, "submitted"
80+
means any form of electronic, verbal, or written communication sent
81+
to the Licensor or its representatives, including but not limited to
82+
communication on electronic mailing lists, source code control systems,
83+
and issue tracking systems that are managed by, or on behalf of, the
84+
Licensor for the purpose of discussing and improving the Work, but
85+
excluding communication that is conspicuously marked or otherwise
86+
designated in writing by the copyright owner as "Not a Contribution."
87+
88+
"Contributor" shall mean Licensor and any individual or Legal Entity
89+
on behalf of whom a Contribution has been received by Licensor and
90+
subsequently incorporated within the Work.
91+
92+
2. Grant of Copyright License. Subject to the terms and conditions of
93+
this License, each Contributor hereby grants to You a perpetual,
94+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
95+
copyright license to reproduce, prepare Derivative Works of,
96+
publicly display, publicly perform, sublicense, and distribute the
97+
Work and such Derivative Works in Source or Object form.
98+
99+
3. Grant of Patent License. Subject to the terms and conditions of
100+
this License, each Contributor hereby grants to You a perpetual,
101+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
102+
(except as stated in this section) patent license to make, have made,
103+
use, offer to sell, sell, import, and otherwise transfer the Work,
104+
where such license applies only to those patent claims licensable
105+
by such Contributor that are necessarily infringed by their
106+
Contribution(s) alone or by combination of their Contribution(s)
107+
with the Work to which such Contribution(s) was submitted. If You
108+
institute patent litigation against any entity (including a
109+
cross-claim or counterclaim in a lawsuit) alleging that the Work
110+
or a Contribution incorporated within the Work constitutes direct
111+
or contributory patent infringement, then any patent licenses
112+
granted to You under this License for that Work shall terminate
113+
as of the date such litigation is filed.
114+
115+
4. Redistribution. You may reproduce and distribute copies of the
116+
Work or Derivative Works thereof in any medium, with or without
117+
modifications, and in Source or Object form, provided that You
118+
meet the following conditions:
119+
120+
(a) You must give any other recipients of the Work or
121+
Derivative Works a copy of this License; and
122+
123+
(b) You must cause any modified files to carry prominent notices
124+
stating that You changed the files; and
125+
126+
(c) You must retain, in the Source form of any Derivative Works
127+
that You distribute, all copyright, patent, trademark, and
128+
attribution notices from the Source form of the Work,
129+
excluding those notices that do not pertain to any part of
130+
the Derivative Works; and
131+
132+
(d) If the Work includes a "NOTICE" text file as part of its
133+
distribution, then any Derivative Works that You distribute must
134+
include a readable copy of the attribution notices contained
135+
within such NOTICE file, excluding those notices that do not
136+
pertain to any part of the Derivative Works, in at least one
137+
of the following places: within a NOTICE text file distributed
138+
as part of the Derivative Works; within the Source form or
139+
documentation, if provided along with the Derivative Works; or,
140+
within a display generated by the Derivative Works, if and
141+
wherever such third-party notices normally appear. The contents
142+
of the NOTICE file are for informational purposes only and
143+
do not modify the License. You may add Your own attribution
144+
notices within Derivative Works that You distribute, alongside
145+
or as an addendum to the NOTICE text from the Work, provided
146+
that such additional attribution notices cannot be construed
147+
as modifying the License.
148+
149+
You may add Your own copyright statement to Your modifications and
150+
may provide additional or different license terms and conditions
151+
for use, reproduction, or distribution of Your modifications, or
152+
for any such Derivative Works as a whole, provided Your use,
153+
reproduction, and distribution of the Work otherwise complies with
154+
the conditions stated in this License.
155+
156+
5. Submission of Contributions. Unless You explicitly state otherwise,
157+
any Contribution intentionally submitted for inclusion in the Work
158+
by You to the Licensor shall be under the terms and conditions of
159+
this License, without any additional terms or conditions.
160+
Notwithstanding the above, nothing herein shall supersede or modify
161+
the terms of any separate license agreement you may have executed
162+
with Licensor regarding such Contributions.
163+
164+
6. Trademarks. This License does not grant permission to use the trade
165+
names, trademarks, service marks, or product names of the Licensor,
166+
except as required for reasonable and customary use in describing the
167+
origin of the Work and reproducing the content of the NOTICE file.
168+
169+
7. Disclaimer of Warranty. Unless required by applicable law or
170+
agreed to in writing, Licensor provides the Work (and each
171+
Contributor provides its Contributions) on an "AS IS" BASIS,
172+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
173+
implied, including, without limitation, any warranties or conditions
174+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
175+
PARTICULAR PURPOSE. You are solely responsible for determining the
176+
appropriateness of using or redistributing the Work and assume any
177+
risks associated with Your exercise of permissions under this License.
178+
179+
8. Limitation of Liability. In no event and under no legal theory,
180+
whether in tort (including negligence), contract, or otherwise,
181+
unless required by applicable law (such as deliberate and grossly
182+
negligent acts) or agreed to in writing, shall any Contributor be
183+
liable to You for damages, including any direct, indirect, special,
184+
incidental, or consequential damages of any character arising as a
185+
result of this License or out of the use or inability to use the
186+
Work (including but not limited to damages for loss of goodwill,
187+
work stoppage, computer failure or malfunction, or any and all
188+
other commercial damages or losses), even if such Contributor
189+
has been advised of the possibility of such damages.
190+
191+
9. Accepting Warranty or Additional Liability. While redistributing
192+
the Work or Derivative Works thereof, You may choose to offer,
193+
and charge a fee for, acceptance of support, warranty, indemnity,
194+
or other liability obligations and/or rights consistent with this
195+
License. However, in accepting such obligations, You may act only
196+
on Your own behalf and on Your sole responsibility, not on behalf
197+
of any other Contributor, and only if You agree to indemnify,
198+
defend, and hold each Contributor harmless for any liability
199+
incurred by, or claims asserted against, such Contributor by reason
200+
of your accepting any such warranty or additional liability.
201+
202+
END OF TERMS AND CONDITIONS
203+
204+
APPENDIX: How to apply the Apache License to your work.
205+
206+
To apply the Apache License to your work, attach the following
207+
boilerplate notice, with the fields enclosed by brackets "{}"
208+
replaced with your own identifying information. (Don't include
209+
the brackets!) The text should be enclosed in the appropriate
210+
comment syntax for the file format. We also recommend that a
211+
file or class name and description of purpose be included on the
212+
same "printed page" as the copyright notice for easier
213+
identification within third-party archives.
214+
215+
Copyright {yyyy} {name of copyright owner}
216+
217+
Licensed under the Apache License, Version 2.0 (the "License");
218+
you may not use this file except in compliance with the License.
219+
You may obtain a copy of the License at
220+
221+
http://www.apache.org/licenses/LICENSE-2.0
222+
223+
Unless required by applicable law or agreed to in writing, software
224+
distributed under the License is distributed on an "AS IS" BASIS,
225+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
226+
See the License for the specific language governing permissions and
227+
limitations under the License.

‎README.md‎

Lines changed: 8 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,18 @@
1-
# workflow-script-highlighter README
1+
# Workflow Script Highlighter
22

3-
This is the README for your extension "workflow-script-highlighter". After writing up a brief description, we recommend including the following sections.
3+
This extension highlights the TypeScript syntax of the @actions/github-script scripts section in the VS Code editor.
4+
Also, it provides a code completion feature.
45

56
## Features
67

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
8+
- Highlight the TypeScript syntax of the @actions/github-script scripts section.
89

9-
For example if there is an image subfolder under your extension project workspace:
10-
11-
\!\[feature X\]\(images/feature-x.png\)
12-
13-
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
10+
![Completion](./images/extension_feature_completion.png)
1411

1512
## Requirements
1613

17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
18-
19-
## Extension Settings
20-
21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22-
23-
For example:
24-
25-
This extension contributes the following settings:
26-
27-
* `myExtension.enable`: Enable/disable this extension.
28-
* `myExtension.thing`: Set to `blah` to do something.
29-
30-
## Known Issues
31-
32-
Calling out known issues can help limit users opening duplicate issues against your extension.
33-
34-
## Release Notes
35-
36-
Users appreciate release notes as you update your extension.
37-
38-
### 1.0.0
39-
40-
Initial release of ...
41-
42-
### 1.0.1
43-
44-
Fixed issue #.
45-
46-
### 1.1.0
47-
48-
Added features X, Y, and Z.
49-
50-
---
51-
52-
## Following extension guidelines
53-
54-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
55-
56-
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
57-
58-
## Working with Markdown
59-
60-
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
61-
62-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
63-
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
64-
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
65-
66-
## For more information
14+
- [GitHub Actions Extension](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions)
6715

68-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
69-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
16+
## Contributing
7017

71-
**Enjoy!**
18+
NEED HELP, See Issues.

‎images/extension_feature_completion.png‎

126 KB
Loading

‎package.json‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
{
22
"name": "workflow-script-highlighter",
3-
"displayName": "",
4-
"description": "",
3+
"displayName": "Workflow Script Highlighter",
4+
"description": "Syntax highlighting for GitHub Actions workflow @actions/github-script's script section.",
5+
"author": {
6+
"name": "yamachu",
7+
"url": "https://github.com/yamachu"
8+
},
9+
"repository": {
10+
"type": "git",
11+
"url": "https://github.com/yamachu/workflow-script-highlighter"
12+
},
513
"version": "0.0.1",
614
"engines": {
715
"vscode": "^1.95.0"

‎vsc-extension-quickstart.md‎

Lines changed: 0 additions & 48 deletions
This file was deleted.

0 commit comments

Comments
 (0)