feat(repo): add scarf to docker image (#3010)

* feat(repo): add scarf analytics tracking for docker image usage

* fix: adjust dockerfile and scarf script

* fix: update readme

* fix: remove comment

* fix: lint docs

Author: micryc

Dockerfile

@@ -3,10 +3,12 @@ FROM node:16-alpine
 WORKDIR /usr/src/spectral
 
 COPY scripts/install.sh /usr/src/spectral/
+COPY scripts/scarf-telemetry.js /usr/local/lib/scarf-telemetry.js
 COPY packages/cli/package.json /usr/src/spectral/
+COPY packages/cli/package.json /usr/local/lib/package.json
 RUN apk --no-cache add curl jq
 RUN ./install.sh $(cat package.json | jq -r '.version') \
   && rm ./install.sh && rm ./package.json
 ENV NODE_ENV production
 
-ENTRYPOINT [ "spectral" ]
+ENTRYPOINT ["sh", "-c", "node /usr/local/lib/scarf-telemetry.js & exec spectral \"$@\"", "sh"]

README.md

@@ -34,6 +34,20 @@ yarn global add @stoplight/spectral-cli
 
 There are also [additional installation options](https://meta.stoplight.io/docs/spectral/ZG9jOjYyMDc0Mw-installation).
 
+### Docker
+
+<!-- make sure to update the value of `--ruleset` according to the actual location of your ruleset -->
+
+```bash
+docker run --rm -it -v $(pwd):/tmp stoplight/spectral lint --ruleset "/tmp/.spectral.yaml" "/tmp/file.yaml"
+```
+
+The Docker image sends a lightweight anonymous telemetry ping on startup (version + platform) to help us understand adoption. To opt out, set `DO_NOT_TRACK=1` or `SCARF_NO_ANALYTICS=true`:
+
+```bash
+docker run --rm -it -e DO_NOT_TRACK=1 -v $(pwd):/tmp stoplight/spectral lint --ruleset "/tmp/.spectral.yaml" "/tmp/file.yaml"
+```
+
 ## 💻 Usage
 
 ### 1. Create a local ruleset

scripts/scarf-telemetry.js

@@ -0,0 +1,19 @@
+const https = require('https');
+
+function reportToScarf() {
+  if (process.env.DO_NOT_TRACK || process.env.SCARF_NO_ANALYTICS === 'true') {
+    return;
+  }
+
+  const version = require('./package.json').version;
+  const platform = `${process.platform}-${process.arch}`;
+  const url = `https://smartbear.gateway.scarf.sh/docker-runtime/${version}/${platform}`;
+
+  const req = https.get(url, { timeout: 2000 }, (res) => {
+    res.resume();
+  });
+  req.on('error', () => {});
+  req.on('timeout', () => req.destroy());
+}
+
+reportToScarf();