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.
70 lines
1.5 KiB
Plaintext
70 lines
1.5 KiB
Plaintext
include::../description.adoc[]
|
|
|
|
include::../ask-yourself.adoc[]
|
|
|
|
include::../recommended.adoc[]
|
|
|
|
== Sensitive Code Example
|
|
|
|
https://github.com/http-party/node-http-proxy[node-http-proxy]
|
|
|
|
----
|
|
var httpProxy = require('http-proxy');
|
|
|
|
httpProxy.createProxyServer({target:'http://localhost:9000', xfwd:true}) // Noncompliant
|
|
.listen(8000);
|
|
----
|
|
|
|
https://github.com/chimurai/http-proxy-middleware[http-proxy-middleware]
|
|
|
|
----
|
|
var express = require('express');
|
|
|
|
const { createProxyMiddleware } = require('http-proxy-middleware');
|
|
|
|
const app = express();
|
|
|
|
app.use('/proxy', createProxyMiddleware({ target: 'http://localhost:9000', changeOrigin: true, xfwd: true })); // Noncompliant
|
|
app.listen(3000);
|
|
----
|
|
|
|
== Compliant Solution
|
|
|
|
https://github.com/http-party/node-http-proxy[node-http-proxy]
|
|
|
|
[source,javascript]
|
|
----
|
|
var httpProxy = require('http-proxy');
|
|
|
|
// By default xfwd option is false
|
|
httpProxy.createProxyServer({target:'http://localhost:9000'}) // Compliant
|
|
.listen(8000);
|
|
----
|
|
|
|
https://github.com/chimurai/http-proxy-middleware[http-proxy-middleware]
|
|
|
|
[source,javascript]
|
|
----
|
|
var express = require('express');
|
|
|
|
const { createProxyMiddleware } = require('http-proxy-middleware');
|
|
|
|
const app = express();
|
|
|
|
// By default xfwd option is false
|
|
app.use('/proxy', createProxyMiddleware({ target: 'http://localhost:9000', changeOrigin: true})); // Compliant
|
|
app.listen(3000);
|
|
----
|
|
|
|
include::../see.adoc[]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|