Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pacav69/grunt-compress-joomla
Compresses Joomla! extensions
https://github.com/pacav69/grunt-compress-joomla
Last synced: 28 days ago
JSON representation
Compresses Joomla! extensions
- Host: GitHub
- URL: https://github.com/pacav69/grunt-compress-joomla
- Owner: pacav69
- License: mit
- Created: 2015-08-13T01:20:29.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-07-02T08:19:38.000Z (over 9 years ago)
- Last Synced: 2023-03-28T00:49:36.632Z (over 1 year ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-compress-joomla [](https://travis-ci.org/renekorss/grunt-compress-joomla)
> Compresses Joomla! extensions
## Getting Started
This plugin requires Grunt `~0.4.5`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-compress-joomla --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-compress-joomla');
```
## Compress task
### Overview
In your project's Gruntfile, add a section named `compress_joomla` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
compress_joomla: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
```
### Extension data
#### extensionName
Type: `String`
This must be folder name of extension. For example `com_example` for `component`.
#### extensionType
Type: `String`
Automatically detected from `extensionName` (supported: `component`, `module`, `plugin`). Can be overridden and is required for `template` and `language`.
Possible values: `component`, `module`, `plugin`, `template` and `language`.
### Options
You can use all [grunt-contrib-compress options](https://github.com/gruntjs/grunt-contrib-compress).
### Usage Examples
#### Default Options
In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`
```js
grunt.initConfig({
compress_joomla: {
options: {
},
extensionName: 'com_example',
extensionType: 'component',
},
});
```
#### Custom Options
In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`
```js
grunt.initConfig({
compress_joomla: {
options: {
mode: 'zip',
punctuation: ' !!!',
},
extensionName: 'com_example',
extensionType: 'component',
},
});
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## Release History
_(Nothing yet)_