|
1 |
| -# grunt-oraclejet 2.3.0 |
2 |
| - |
3 |
| -## About the module |
4 |
| -This module contains build and serve tasks for Oracle JET web and hybrid mobile applications. |
5 |
| - |
6 |
| -This is an open source project maintained by Oracle Corp. |
7 |
| - |
8 |
| -## Installation |
9 |
| -The grunt-oraclejet module will be automatically installed if you scaffold a web or hybrid mobile app following the [Oracle JET Developers Guide](http://docs.oracle.com/middleware/jet230/jet/). |
10 |
| - |
11 |
| -### Manual installation |
12 |
| -This plugin requires Grunt `~1.0.1` |
13 |
| - |
14 |
| -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: |
15 |
| - |
16 |
| -```shell |
17 |
| -npm install grunt-oraclejet --save-dev |
18 |
| -``` |
19 |
| - |
20 |
| -Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript: |
21 |
| - |
22 |
| -```js |
23 |
| -grunt.loadNpmTasks('grunt-oraclejet'); |
24 |
| -``` |
25 |
| - |
26 |
| -## Usage |
27 |
| - |
28 |
| -### Overview |
29 |
| -In your project's Gruntfile, add a section named `oraclejet` to the data object passed into `grunt.initConfig()`. |
30 |
| - |
31 |
| -```js |
32 |
| -grunt.initConfig({ |
33 |
| - oraclejet: { |
34 |
| - options: { |
35 |
| - // Task-specific options go here. |
36 |
| - }, |
37 |
| - your_target: { |
38 |
| - // Target-specific file lists and/or options go here. |
39 |
| - }, |
40 |
| - }, |
41 |
| -}); |
42 |
| -``` |
43 |
| - |
44 |
| -### Options |
45 |
| - |
46 |
| -#### options.separator |
47 |
| -Type: `String` |
48 |
| -Default value: `', '` |
49 |
| - |
50 |
| -A string value that is used to do something with whatever. |
51 |
| - |
52 |
| -#### options.punctuation |
53 |
| -Type: `String` |
54 |
| -Default value: `'.'` |
55 |
| - |
56 |
| -A string value that is used to do something else with whatever else. |
57 |
| - |
58 |
| -### Usage Examples |
59 |
| - |
60 |
| -#### Default Options |
61 |
| -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.` |
62 |
| - |
63 |
| -```js |
64 |
| -grunt.initConfig({ |
65 |
| - oraclejet: { |
66 |
| - options: {}, |
67 |
| - files: { |
68 |
| - 'dest/default_options': ['src/testing', 'src/123'], |
69 |
| - }, |
70 |
| - }, |
71 |
| -}); |
72 |
| -``` |
73 |
| - |
74 |
| -#### Custom Options |
75 |
| -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 !!!` |
76 |
| - |
77 |
| -```js |
78 |
| -grunt.initConfig({ |
79 |
| - oraclejet: { |
80 |
| - options: { |
81 |
| - separator: ': ', |
82 |
| - punctuation: ' !!!', |
83 |
| - }, |
84 |
| - files: { |
85 |
| - 'dest/default_options': ['src/testing', 'src/123'], |
86 |
| - }, |
87 |
| - }, |
88 |
| -}); |
89 |
| -``` |
90 |
| - |
91 |
| -## [Contributing](https://github.com/oracle/grunt-oraclejet/tree/master/CONTRIBUTING.md) |
92 |
| -Oracle JET is an open source project. Pull Requests are currently not being accepted. See |
93 |
| -[CONTRIBUTING](https://github.com/oracle/grunt-oraclejet/tree/master/CONTRIBUTING.md) |
94 |
| -for details. |
95 |
| - |
96 |
| -## [License](https://github.com/oracle/grunt-oraclejet/tree/master/LICENSE.md) |
97 |
| -Copyright (c) 2014, 2017 Oracle and/or its affiliates |
| 1 | +# grunt-oraclejet 3.0.0 |
| 2 | + |
| 3 | +## About the module |
| 4 | +This module contains build and serve tasks for Oracle JET web and hybrid mobile applications. |
| 5 | + |
| 6 | +This is an open source project maintained by Oracle Corp. |
| 7 | + |
| 8 | +## Installation |
| 9 | +The grunt-oraclejet module will be automatically installed if you scaffold a web or hybrid mobile app following the [Oracle JET Developers Guide](http://docs.oracle.com/middleware/jet300/jet/). |
| 10 | + |
| 11 | +### Manual installation |
| 12 | +This plugin requires Grunt `~1.0.1` |
| 13 | + |
| 14 | +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: |
| 15 | + |
| 16 | +```shell |
| 17 | +npm install grunt-oraclejet --save-dev |
| 18 | +``` |
| 19 | + |
| 20 | +Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript: |
| 21 | + |
| 22 | +```js |
| 23 | +grunt.loadNpmTasks('grunt-oraclejet'); |
| 24 | +``` |
| 25 | + |
| 26 | +## Usage |
| 27 | + |
| 28 | +### Overview |
| 29 | +In your project's Gruntfile, add a section named `oraclejet` to the data object passed into `grunt.initConfig()`. |
| 30 | + |
| 31 | +```js |
| 32 | +grunt.initConfig({ |
| 33 | + oraclejet: { |
| 34 | + options: { |
| 35 | + // Task-specific options go here. |
| 36 | + }, |
| 37 | + your_target: { |
| 38 | + // Target-specific file lists and/or options go here. |
| 39 | + }, |
| 40 | + }, |
| 41 | +}); |
| 42 | +``` |
| 43 | + |
| 44 | +### Options |
| 45 | + |
| 46 | +#### options.separator |
| 47 | +Type: `String` |
| 48 | +Default value: `', '` |
| 49 | + |
| 50 | +A string value that is used to do something with whatever. |
| 51 | + |
| 52 | +#### options.punctuation |
| 53 | +Type: `String` |
| 54 | +Default value: `'.'` |
| 55 | + |
| 56 | +A string value that is used to do something else with whatever else. |
| 57 | + |
| 58 | +### Usage Examples |
| 59 | + |
| 60 | +#### Default Options |
| 61 | +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.` |
| 62 | + |
| 63 | +```js |
| 64 | +grunt.initConfig({ |
| 65 | + oraclejet: { |
| 66 | + options: {}, |
| 67 | + files: { |
| 68 | + 'dest/default_options': ['src/testing', 'src/123'], |
| 69 | + }, |
| 70 | + }, |
| 71 | +}); |
| 72 | +``` |
| 73 | + |
| 74 | +#### Custom Options |
| 75 | +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 !!!` |
| 76 | + |
| 77 | +```js |
| 78 | +grunt.initConfig({ |
| 79 | + oraclejet: { |
| 80 | + options: { |
| 81 | + separator: ': ', |
| 82 | + punctuation: ' !!!', |
| 83 | + }, |
| 84 | + files: { |
| 85 | + 'dest/default_options': ['src/testing', 'src/123'], |
| 86 | + }, |
| 87 | + }, |
| 88 | +}); |
| 89 | +``` |
| 90 | + |
| 91 | +## [Contributing](https://github.com/oracle/grunt-oraclejet/tree/master/CONTRIBUTING.md) |
| 92 | +Oracle JET is an open source project. Pull Requests are currently not being accepted. See |
| 93 | +[CONTRIBUTING](https://github.com/oracle/grunt-oraclejet/tree/master/CONTRIBUTING.md) |
| 94 | +for details. |
| 95 | + |
| 96 | +## [License](https://github.com/oracle/grunt-oraclejet/tree/master/LICENSE.md) |
| 97 | +Copyright (c) 2014, 2017 Oracle and/or its affiliates |
98 | 98 | The Universal Permissive License (UPL), Version 1.0
|
0 commit comments