Skip to content

Commit 8e2b4ca

Browse files
committed
Format docs
1 parent a69aee8 commit 8e2b4ca

19 files changed

+110
-96
lines changed
Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
---
2-
name: Bug report
3-
about: Report a bug
4-
title: ''
5-
labels: bug
6-
7-
---
8-
9-
**Describe the bug**
10-
A clear and concise description of what the bug is.
11-
12-
**To Reproduce**
13-
Steps to reproduce the behavior:
14-
1. Go to '...'
15-
2. Click on '....'
16-
3. Scroll down to '....'
17-
4. See error
18-
19-
**Expected behavior**
20-
A clear and concise description of what you expected to happen.
21-
22-
**Node version**
23-
Include your Node version here.
24-
25-
**ESLint version**
26-
Include you base ESLint package version here.
27-
28-
**Screenshots**
29-
If applicable, add screenshots to help explain your problem.
30-
31-
**Additional context**
32-
Add any other context about the problem here.
1+
---
2+
name: Bug report
3+
about: Report a bug
4+
title: ''
5+
labels: bug
6+
---
7+
8+
**Describe the bug**
9+
A clear and concise description of what the bug is.
10+
11+
**To Reproduce**
12+
Steps to reproduce the behavior:
13+
14+
1. Go to '...'
15+
2. Click on '....'
16+
3. Scroll down to '....'
17+
4. See error
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Node version**
23+
Include your Node version here.
24+
25+
**ESLint version**
26+
Include you base ESLint package version here.
27+
28+
**Screenshots**
29+
If applicable, add screenshots to help explain your problem.
30+
31+
**Additional context**
32+
Add any other context about the problem here.
Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
---
2-
name: Feature/change request
3-
about: Suggest an new feature or change
4-
title: ''
5-
labels: feature-request
6-
7-
---
8-
9-
**Is your feature request related to a problem? Please describe.**
10-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11-
12-
**Describe the solution you'd like**
13-
A clear and concise description of what you want to happen.
14-
15-
**Describe alternatives you've considered**
16-
A clear and concise description of any alternative solutions or features you've considered.
17-
18-
**Additional context**
19-
Add any other context or screenshots about the feature request here.
1+
---
2+
name: Feature/change request
3+
about: Suggest an new feature or change
4+
title: ''
5+
labels: feature-request
6+
---
7+
8+
**Is your feature request related to a problem? Please describe.**
9+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
11+
**Describe the solution you'd like**
12+
A clear and concise description of what you want to happen.
13+
14+
**Describe alternatives you've considered**
15+
A clear and concise description of any alternative solutions or features you've considered.
16+
17+
**Additional context**
18+
Add any other context or screenshots about the feature request here.

docs/rules/api-version.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,15 @@ Valid tag values are `1.0`, `2.x`, `2.0`, and `2.1`.
2727
* @NApiVersion
2828
*/
2929
```
30+
3031
```js
3132
/* eslint suitescript/api-version: "error" */
3233

3334
/**
3435
* @NApiVersion2
3536
*/
3637
```
38+
3739
```js
3840
/* eslint suitescript/api-version: "error" */
3941

@@ -48,4 +50,4 @@ This rule was introduced in version 1.0.0.
4850

4951
## Source
5052

51-
- [Rule source](../../lib/rules/api-version.js)
53+
- [Rule source](../../lib/rules/api-version.js)

docs/rules/entry-points.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,6 @@ define([], function () {
138138
- WorkflowActionScript
139139
- onAction
140140

141-
142141
## Version
143142

144143
This rule was introduced in version 1.0.0.

docs/rules/log-args.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ If no options are provided, the rule will require both title and details.
1313

1414
log.debug({ title: 'Title', details: 'Details' });
1515
```
16+
1617
```js
1718
/* eslint suitescript/log-args: "error" */
1819

1920
log.audit('Title', 'Details');
2021
```
22+
2123
```js
2224
/* eslint suitescript/log-args: "error" */
2325

@@ -31,6 +33,7 @@ log.error('', 'Details');
3133

3234
log.debug('Title');
3335
```
36+
3437
```js
3538
/* eslint suitescript/log-args: "error" */
3639

@@ -78,4 +81,4 @@ This rule was introduced in version 1.0.0.
7881

7982
## Source
8083

81-
- [Rule source](../../lib/rules/log-args.js)
84+
- [Rule source](../../lib/rules/log-args.js)

docs/rules/module-vars.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@ Specify at least one module name with a corresponding variable name.
9898
- N/workflow
9999
- N/xml
100100

101-
102101
## Version
103102

104103
This rule was introduced in version 1.0.0.

docs/rules/no-amd-name.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ Naming AMD modules [should generally be avoided](https://requirejs.org/docs/whya
1313
```js
1414
/* eslint suitescript/no-amd-name: "error" */
1515

16-
define([], function() {});
16+
define([], function () {});
1717
```
1818

1919
:x: The following pattern is **incorrect**:
2020

2121
```js
2222
/* eslint suitescript/no-amd-name: "error" */
2323

24-
define('myModule', [], function() {});
24+
define('myModule', [], function () {});
2525
```
2626

2727
## Version
@@ -30,4 +30,4 @@ This rule was introduced in version 1.0.0.
3030

3131
## Source
3232

33-
- [Rule source](../../lib/rules/no-amd-name.js)
33+
- [Rule source](../../lib/rules/no-amd-name.js)

docs/rules/no-extra-modules.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,27 @@ Enforces an equal number of module literals and identifiers in the `define` call
99
```js
1010
/* eslint suitescript/no-extra-modules: "error" */
1111

12-
define([], function() {});
12+
define([], function () {});
1313
```
14+
1415
```js
1516
/* eslint suitescript/no-extra-modules: "error" */
1617

17-
define(['N/search'], function(search) {});
18+
define(['N/search'], function (search) {});
1819
```
1920

2021
:x: The following patterns are **incorrect**:
2122

2223
```js
2324
/* eslint suitescript/no-extra-modules: "error" */
2425

25-
define(['N/file'], function(file, record) {});
26+
define(['N/file'], function (file, record) {});
2627
```
28+
2729
```js
2830
/* eslint suitescript/no-extra-modules: "error" */
2931

30-
define(['N/file', 'N/record'], function(file) {});
32+
define(['N/file', 'N/record'], function (file) {});
3133
```
3234

3335
## Version
@@ -36,4 +38,4 @@ This rule was introduced in version 1.0.0.
3638

3739
## Source
3840

39-
- [Rule source](../../lib/rules/no-extra-modules.js)
41+
- [Rule source](../../lib/rules/no-extra-modules.js)

docs/rules/no-invalid-modules.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,27 @@ Enforces valid SuiteScript module names in the `define` array.
99
```js
1010
/* eslint suitescript/no-invalid-modules: "error" */
1111

12-
define(['N/record'], function(record) {});
12+
define(['N/record'], function (record) {});
1313
```
14+
1415
```js
1516
/* eslint suitescript/no-invalid-modules: "error" */
1617

17-
define(['N/https', 'N/search'], function(https, search) {});
18+
define(['N/https', 'N/search'], function (https, search) {});
1819
```
20+
1921
```js
2022
/* eslint suitescript/no-invalid-modules: "error" */
2123

22-
define(['customModule'], function(customModule) {});
24+
define(['customModule'], function (customModule) {});
2325
```
2426

2527
:x: The following pattern is **incorrect**:
2628

2729
```js
2830
/* eslint suitescript/no-invalid-modules: "error" */
2931

30-
define(['N/somethingElse'], function(somethingElse) {});
32+
define(['N/somethingElse'], function (somethingElse) {});
3133
```
3234

3335
## Version
@@ -36,4 +38,4 @@ This rule was introduced in version 1.0.0.
3638

3739
## Source
3840

39-
- [Rule source](../../lib/rules/no-invalid-modules.js)
41+
- [Rule source](../../lib/rules/no-invalid-modules.js)

docs/rules/no-log-module.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ By default, the N/log module is allowed in client scripts because there it is us
1313
```js
1414
/* eslint suitescript/no-log-module: "error" */
1515

16-
define([], function() {
16+
define([], function () {
1717
log.debug('Title', 'Details');
1818
});
1919
```
@@ -23,7 +23,7 @@ define([], function() {
2323
```js
2424
/* eslint suitescript/no-log-module: "error" */
2525

26-
define(['N/log'], function(log) {
26+
define(['N/log'], function (log) {
2727
log.debug('Title', 'Details');
2828
});
2929
```
@@ -48,7 +48,7 @@ Allows the N/log module to be loaded in client scripts.
4848
/**
4949
* @NScriptType ClientScript',
5050
*/
51-
define([], function() {
51+
define([], function () {
5252
console.log("can't use N\log");
5353
});
5454
```
@@ -59,4 +59,4 @@ This rule was introduced in version 1.0.0.
5959

6060
## Source
6161

62-
- [Rule source](../../lib/rules/no-log-module.js)
62+
- [Rule source](../../lib/rules/no-log-module.js)

0 commit comments

Comments
 (0)