https://github.com/ninetwozero/gradle-to-js

A quick & dirty Gradle build file to JavaScript object parser
https://github.com/ninetwozero/gradle-to-js

Last synced: 2 days ago
JSON representation

A quick & dirty Gradle build file to JavaScript object parser

• Host: GitHub
• URL: https://github.com/ninetwozero/gradle-to-js
• Owner: ninetwozero
• License: apache-2.0
• Created: 2016-01-27T00:15:36.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T18:36:14.000Z (9 months ago)
• Last Synced: 2025-01-02T06:05:21.094Z (13 days ago)
• Language: JavaScript
• Size: 162 KB
• Stars: 47
• Watchers: 3
• Forks: 21
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs-pure-js - gradle

README

        
# gradle-to-js

[![NPM Version](https://img.shields.io/npm/v/gradle-to-js.svg)](https://www.npmjs.com/package/gradle-to-js)

[![Build Status][1]][2]

## What's this `gradle-to-js` thing?

gradle-to-js is a quick & dirty Gradle build file to JavaScript object parser. It is quick & dirty in the sense that it doesn't give you an exact replica of whatever the build file represents during runtime, as evaluations and similar bits are (currently) too much of a hassle to accurately represent while parsing.

## Installation

Simply run the following command to include it into your project:

```sh

npm install gradle-to-js --save

```

## Usage

### As a module

Using `gradle-to-js` as a module, you can parse both strings and files as seen below.

#### Files

```js

var g2js = require('gradle-to-js/lib/parser');

g2js.parseFile('path/to/buildfile').then(function(representation) {

  console.log(representation);

});

```

#### Strings

```js

var g2js = require('gradle-to-js/lib/parser');

g2js.parseText('key "value"').then(function(representation) {

  console.log(representation);

});

```

The promise will eventually resolve an object matching the build file structure and values.

### Using the CLI

You can also use the module directly from the CLI, and get a json representation out of it. Nifty ey? Currently only supporting files from this direction.

```bash

./index.js test/sample-data/small.build.gradle

```

```json

{

  "testblock": {

    "key1": "value1",

    "key2": "value2",

    "nestedKey": {

      "key3": "value3",

      "key4": "value4",

      "key5": {

        "key6": "value6"

      }

    }

  },

  "testblock2": {

    "key1": "value1",

    "key2": "value2"

  },

  "testblock3": "not really"

}

```

## Author

[Karl Lindmark](https://www.github.com/karllindmark)

## License

Apache 2.0

[1]: https://github.com/ninetwozero/gradle-to-js/workflows/ci/badge.svg

[2]: https://github.com/ninetwozero/gradle-to-js/actions