https://github.com/hangxingliu/vscode-awk-hint

:wrench: VS Code extension: AWK hint(auto-completion)
https://github.com/hangxingliu/vscode-awk-hint

autocomplete awk gawk hint vscode vscode-extension

Last synced: 3 days ago
JSON representation

:wrench: VS Code extension: AWK hint(auto-completion)

• Host: GitHub
• URL: https://github.com/hangxingliu/vscode-awk-hint
• Owner: hangxingliu
• License: gpl-3.0
• Created: 2017-04-10T07:39:33.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-11-27T07:31:55.000Z (about 6 years ago)
• Last Synced: 2025-02-12T04:49:33.342Z (7 days ago)
• Topics: autocomplete, awk, gawk, hint, vscode, vscode-extension
• Language: JavaScript
• Homepage:
• Size: 168 KB
• Stars: 8
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AWK hint(auto-completion) for VS Code

[![Build Status](https://travis-ci.org/hangxingliu/vscode-awk-hint.svg?branch=master)](https://travis-ci.org/hangxingliu/vscode-awk-hint)

An **experimental** extension.   

And the hint data generated from [The GNU Awk User’s Guide][gnu-awk-doc] by [scripts][doc-script]    

You can report bug or send a feature suggestion in [Github Issues Page][issues].

## Installation

1. Click `Extension` button in left side of VSCode. (Shortcut: Ctrl+Shift+X)

2. Search `vscode-awk-hint`. Found this extension and click `Install` button.

3. Reload VSCode.

## Hint Support

1. awk function hint

2. awk built-in variable hint

3. awk statement snippets

## Declaration

1. This extension depend extension [`luggage66.AWK` developed by Donald Mull Jr][ext-awk] (**It will be install automaticallly by VS Code**)

2. Open source license of this extension is [GPL-3.0](LICENSE)

## Contributing to the Extension

### 1. Supporting me coffee via Paypal

[Supporting me coffee][paypal] could encourage me to make my vscode extensions better and better!

(and add more and more features).

### 2. Submit issue on Github

Found a bug, feature request or question. You can submit issue on [Github Issue Page][issues];

### 3. Cook by yourself

0. prepare node.js environment

1. fork this repo on Github, then clone it to local

2. execute `npm install --save-dev`

3. modify/fix it

4. please remember `npm test` for unit tets

5. give a [pull request][pr]

Project structure:

- `extension`: extension codes

	- `main.js`: entry file of extension

	- `parser/awk.js`: awk semantic parser

	- `vscode.d.ts` & `index.d.ts`: typing files for auto-completion

- `hint-data`: hint data json file generated automatically(But `snippets.json` is written by me)

- `icon`: png and svg icon images for this extension

- `test`: unit tests

- `utils`: utilities (scripts for fetch awk hint data)

## License

[GPL-3.0](LICENSE)

## Author

[Liu Yue @hangxingliu](https://github.com/hangxingliu)

[gnu-awk-doc]: https://www.gnu.org/software/gawk/manual/gawk.html

[doc-script]: https://github.com/hangxingliu/vscode-awk-hint/tree/master/utils

[ext-awk]: https://marketplace.visualstudio.com/items?itemName=luggage66.awk

[issues]: https://github.com/hangxingliu/vscode-awk-hint/issues

[pr]: https://github.com/hangxingliu/vscode-awk-hint/pulls

[paypal]: https://www.paypal.me/hangxingliu