Skip to content

Commit

Permalink
fix: first release
Browse files Browse the repository at this point in the history
  • Loading branch information
nguyenngoclongdev committed Jun 5, 2023
1 parent 6f51571 commit 62ee0bf
Show file tree
Hide file tree
Showing 31 changed files with 9,533 additions and 2 deletions.
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
11 changes: 11 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
24 changes: 24 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 6,
"sourceType": "module"
},
"plugins": [
"@typescript-eslint"
],
"rules": {
"@typescript-eslint/naming-convention": "warn",
"@typescript-eslint/semi": "warn",
"curly": "warn",
"eqeqeq": "warn",
"no-throw-literal": "warn",
"semi": "off"
},
"ignorePatterns": [
"out",
"dist",
"**/*.d.ts"
]
}
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# These are supported funding model platforms

github: [nguyenngoclongdev]
ko_fi: nguyenngoclong
72 changes: 72 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: ci

on:
push:
branches:
- main

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16.x
cache: 'npm'

- name: Install dependency
run: npm ci
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

- name: Check style and format
run: npm run lint
- name: Test package
uses: coactions/setup-xvfb@v1
with:
run: npm test

publish:
needs: [test]
runs-on: ubuntu-latest
permissions:
contents: write # to create release (changesets/action)
pull-requests: write # to create pull request (changesets/action)
steps:
- uses: actions/checkout@v3
with:
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
fetch-depth: 0

- uses: actions/setup-node@v3
with:
node-version: 16.x
cache: 'npm'

- name: Install dependency
run: npm ci
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

- name: Create Release Pull Request or publish package
id: changesets
uses: changesets/action@v1
with:
commit: 'chore: update versions'
title: 'chore: update versions'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Publish to Visual Studio Marketplace
if: steps.changesets.outputs.hasChangesets == 'true'
uses: HaaLeo/publish-vscode-extension@v1
with:
pat: ${{ secrets.VSCE_PAT }}
registryUrl: https://marketplace.visualstudio.com

- name: Publish to Open VSX Registry
if: steps.changesets.outputs.hasChangesets == 'true'
uses: HaaLeo/publish-vscode-extension@v1
with:
pat: ${{ secrets.OPEN_VSX_TOKEN }}
28 changes: 28 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: test

on:
push:
branches:
- develop

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16.x
cache: 'npm'

- name: Install dependency
run: npm ci
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

- name: Check style and format
run: npm run lint
- name: Test package
uses: coactions/setup-xvfb@v1
with:
run: npm test
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
dist
node_modules
.vscode-test/
*.vsix
**/.DS_Store
.npmrc
temp.*
**/.DS_Store
src/__test__/fixtures/*.ts
pnpm-lock.yaml
yarn-lock.json
3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": ["nguyenngoclong.cypress-cucumber-step-definition-generator"]
}
37 changes: 37 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Run Extension",
"type": "extensionHost",
"request": "launch",
"runtimeExecutable": "${execPath}",
"args": ["--extensionDevelopmentPath=${workspaceFolder}"],
"sourceMaps": true,
"outFiles": ["${workspaceFolder}/dist/**/*.js"],
"preLaunchTask": "npm: watch"
},
{
"name": "Run Web Extension in VS Code",
"type": "extensionHost",
"debugWebWorkerHost": true,
"request": "launch",
"args": ["--extensionDevelopmentPath=${workspaceFolder}", "--extensionDevelopmentKind=web"],
"outFiles": ["${workspaceFolder}/dist/web/**/*.js"],
"preLaunchTask": "npm: watch-web"
},
{
"name": "Extension Tests",
"type": "extensionHost",
"request": "launch",
"args": [
"--extensionDevelopmentPath=${workspaceFolder}",
"--extensionTestsPath=${workspaceFolder}/dist/__test__/suite/index",
"--launchArgs=${workspaceFolder}/src/__test__/fixtures/",
"--disable-extensions"
],
"outFiles": ["${workspaceFolder}/dist/__test__/**/*.js"],
"preLaunchTask": "${defaultBuildTask}"
}
]
}
33 changes: 33 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"files.exclude": {
"out": false, // set this to true to hide the "out" folder with the compiled JS files
"dist": false
},
"search.exclude": {
"out": true, // set this to false to include "out" folder in search results
"dist": false
},
// Turn off tsc task auto detection since we have the necessary tasks as npm scripts
"typescript.tsc.autoDetect": "off",
// Custom setting
"editor.defaultFormatter": "esbenp.prettier-vscode",
"prettier.singleQuote": true,
"prettier.tabWidth": 4,
"prettier.printWidth": 120,
"prettier.trailingComma": "none",
"prettier.semi": true,
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[feature]": {
"editor.defaultFormatter": "nguyenngoclong.gherkin-editor"
},
"files.associations": {
"*.feature": "feature",
"*.features": "feature",
"*.out": "plaintext"
},
"gitlens.currentLine.enabled": false,
"gitlens.hovers.currentLine.over": "line",
"gitlens.codeLens.enabled": false
}
34 changes: 34 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "watch",
"problemMatcher": "$tsc-watch",
"isBackground": true,
"presentation": {
"reveal": "never"
},
"group": {
"kind": "build",
"isDefault": true
}
},
{
"type": "npm",
"script": "compile-web",
"group": {
"kind": "build",
"isDefault": true
},
"problemMatcher": ["$ts-webpack", "$tslint-webpack"]
},
{
"type": "npm",
"script": "watch-web",
"group": "build",
"isBackground": true,
"problemMatcher": ["$ts-webpack-watch", "$tslint-webpack-watch"]
}
]
}
16 changes: 16 additions & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.github
.vscode
images/
node_modules
src/
out/
.eslintrc.json
.gitignore
.vscodeignore
*.vsix
tsconfig.json
test
resources
.vscode-test/**
.changeset
dist/__test__
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Gherkin Editor
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 nguyenngoclongdev

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
63 changes: 61 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,61 @@
# gherkin-syntax
Validator and highlight
[![CI](https://github.com/nguyenngoclongdev/gherkin-editor/actions/workflows/ci.yml/badge.svg)](https://github.com/nguyenngoclongdev/gherkin-editor/actions/workflows/ci.yml)

[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/nguyenngoclong.gherkin-editor)](https://marketplace.visualstudio.com/items?itemName=nguyenngoclong.gherkin-editor)
[![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/nguyenngoclong.gherkin-editor)](https://marketplace.visualstudio.com/items?itemName=nguyenngoclong.gherkin-editor)
[![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/nguyenngoclong.gherkin-editor)](https://marketplace.visualstudio.com/items?itemName=nguyenngoclong.gherkin-editor)
[![Visual Studio Marketplace Rating (Stars)](https://img.shields.io/visual-studio-marketplace/stars/nguyenngoclong.gherkin-editor)](https://marketplace.visualstudio.com/items?itemName=nguyenngoclong.gherkin-editor)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)

# Gherkin Editor

Beautiful syntax highlighting support for Gherkin Syntax in Visual Studio Code.

If you find this extension useful for your testing projects, please consider supporting me by [Buy Me a Coffee](https://ko-fi.com/D1D2LBPX9). It's a great way to help me maintain and improve this tool in the future. Your support is truly appreciated!

<a href='https://ko-fi.com/D1D2LBPX9' target='_blank'>
<img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi3.png?v=3' border='0' alt='Buy Me a Coffee' />
</a>

# Installation

Get it from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=nguyenngoclong.gherkin-editor) or [Open VSX Registry](https://open-vsx.org/extension/nguyenngoclong/gherkin-editor).

# Features

- Syntax highlighting


## Using the extension

![Gherkin Editor](https://github.com/nguyenngoclongdev/gherkin-editor/raw/HEAD/images/gherkin-editor.png)

1. Open any .feature file in VS Code editor.
2. Click on the "View" menu and select "Command Palette" (or simply press "Ctrl + Shift + P" on Windows/Linux or "Cmd + Shift + P" on Mac).
2. Type "Change Language Mode" in the "Command Palette" and select it.
2. Select "Configure File Association for '.feature'" and choose `feature` from the list of available languages.

Quick Settings
```json
"files.associations": {
"*.feature": "feature"
}
```

Now Visual Studio Code will recognize `.feature` files as cucumber files and provide syntax highlighting, code completion, and other language-specific features.

## Roadmaps

- ■■■■■■■■■■ 100% Syntax Highlight
- □□□□□□□□□□ 0% Code Completion
- ■■□□□□□□□□ 20% Format & Validator
- □□□□□□□□□□ 0% Context Outline (Tree View)


## Feedback

If you discover a bug, or have a suggestion for a feature request, please
submit an [issue](https://github.com/nguyenngoclongdev/gherkin-editor/issues).

## LICENSE

This extension is licensed under the [MIT License](LICENSE)
Binary file added assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/gherkin-syntax.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/original/logo.logoist
Binary file not shown.
Loading

0 comments on commit 62ee0bf

Please sign in to comment.