51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
53 lines
858 B
Plaintext
53 lines
858 B
Plaintext
include::../description.adoc[]
|
|
|
|
include::../ask-yourself.adoc[]
|
|
|
|
include::../recommended.adoc[]
|
|
|
|
== Sensitive Code Example
|
|
|
|
----
|
|
const fs = require('fs');
|
|
|
|
let tmp_file = "/tmp/temporary_file"; // Sensitive
|
|
fs.readFile(tmp_file, 'utf8', function (err, data) {
|
|
// ...
|
|
});
|
|
----
|
|
|
|
----
|
|
const fs = require('fs');
|
|
|
|
let tmp_dir = process.env.TMPDIR; // Sensitive
|
|
fs.readFile(tmp_dir + "/temporary_file", 'utf8', function (err, data) {
|
|
// ...
|
|
});
|
|
----
|
|
|
|
== Compliant Solution
|
|
|
|
[source,javascript]
|
|
----
|
|
const tmp = require('tmp');
|
|
|
|
const tmpobj = tmp.fileSync(); // Compliant
|
|
----
|
|
|
|
include::../see.adoc[]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|