Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/plumthedev/vsc-translate-snippets

Add more programming languages ​​for your Visual Studio Code snippet plugin programmatically
https://github.com/plumthedev/vsc-translate-snippets

vsc vscode vscode-extension vscode-snippets

Last synced: 3 days ago
JSON representation

Add more programming languages ​​for your Visual Studio Code snippet plugin programmatically

Awesome Lists containing this project

README

        

# VSC Translate Snippets
[![Build Status](https://travis-ci.org/plumthedev/vsc-translate-snippets.svg?branch=master)](https://travis-ci.org/plumthedev/vsc-translate-snippets)

[![NPM](https://nodei.co/npm/vsc-translate-snippets.png)](https://nodei.co/npm/vsc-translate-snippets/)

Add more programming languages ​​for your Visual Studio Code snippet plugin

## Supported languages

For the present moment we support 1 programming language

* from **HTML** to **Pug/Jade**

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

What things you need to install the software and how to install them

```
npm install
```

### Development and running

A step by step series of examples that tell you how to get a development env running

#### Development

```
npm run dev
```

#### Running

```
npm run build
```

#### Demo show

```
cd demo
node index.js
```

#### Usage in code

```
const { vscts } = require('vsc-translate-snippets');

vscts.jade({
source: './data/snippets.json', // path to your original source file
translatedPath: './translated/', // path to the folder where the translation file will be placed
translatedFilename: 'jade-snippets.json' // name of translation file
});
```

## Running the tests

```
npm run test
```

## Built With

* [html2pug](https://github.com/izolate/html2pug) - Converts HTML to Pug templating language by [izolate](https://github.com/izolate)
* [jest](https://github.com/facebook/jest) - JavaScript Testing Framework by [Facebook](https://github.com/facebook)

## Contributing

If you want to contributing it is a free path

## Authors

* **Kacper Pruszynski** - *Initial work* - [plum](https://github.com/plumthedev)

These people make this tool much more useful, more efficient and better, thanks a lot!
* **Karol Jasik** - *Added classes modules and tests* - [crusadeDev](https://github.com/crusadeDev)

## License

GNU GPL v3