@tryghost/domain-validator 4.0.1 → 4.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -5
  2. package/package.json +12 -10
package/README.md CHANGED
@@ -1,24 +1,41 @@
1
1
  # Domain Validator
2
2
 
3
+ Validate whether a custom domain is ready to be used with Ghost(Pro). The
4
+ validator checks the expected Ghost(Pro) subdomain, DNS records, proxy setup, and
5
+ optional CAA issuer requirements, then returns a structured validity report.
6
+
7
+ ## Usage
8
+
9
+ ```js
10
+ const validator = require('@tryghost/domain-validator');
11
+
12
+ const report = await validator.validate('example', 'www.example.com', '', 'ghost.io', [
13
+ 'certainly.com',
14
+ 'letsencrypt.org',
15
+ ]);
16
+
17
+ console.log(report.isDnsValidForSSL);
18
+ ```
19
+
3
20
  ## Installation
4
21
 
5
22
  1. Make sure that `gstenv` is green. See [Dev Environment](https://github.com/TryGhost/Team/blob/master/Engineering/Dev%20Environment.md) for docs.
6
23
  2. `git clone` this repo & `cd` into it as usual
7
- 3. Run `yarn` to install top-level dependencies.
24
+ 3. Run `pnpm install` to install top-level dependencies.
8
25
 
9
26
  ## Run
10
27
 
11
- - Use: `yarn dev`
28
+ - CLI: `pnpm --filter @tryghost/domain-validator dv -- www.example.com example`
12
29
  - View: [http://localhost:9999](http://localhost:9999)
13
30
 
14
31
  ## Test
15
32
 
16
- - `yarn lint` run just eslint
17
- - `yarn test` run lint && tests
33
+ - `pnpm --filter @tryghost/domain-validator lint` runs lint
34
+ - `pnpm --filter @tryghost/domain-validator test` runs lint and tests
18
35
 
19
36
  ## Publish
20
37
 
21
- - `yarn ship`
38
+ - Use the top-level publish instructions.
22
39
 
23
40
  # Copyright & License
24
41
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tryghost/domain-validator",
3
- "version": "4.0.1",
3
+ "version": "4.0.3",
4
4
  "license": "MIT",
5
5
  "author": "Ghost Foundation",
6
6
  "repository": {
@@ -18,25 +18,27 @@
18
18
  ],
19
19
  "main": "lib/validate.js",
20
20
  "dependencies": {
21
- "@tryghost/debug": "2.0.3",
22
- "@tryghost/errors": "3.0.3",
23
- "@tryghost/pretty-cli": "3.0.3",
21
+ "@tryghost/debug": "2.3.0",
22
+ "@tryghost/errors": "3.3.0",
23
+ "@tryghost/pretty-cli": "3.3.0",
24
24
  "bluebird": "3.7.2",
25
25
  "got": "11.8.6",
26
- "lodash": "4.17.23",
27
- "semver": "7.7.4",
28
- "@tryghost/dns": "^0.8.1"
26
+ "lodash": "4.18.1",
27
+ "semver": "7.8.5",
28
+ "@tryghost/dns": "^0.8.3"
29
29
  },
30
30
  "devDependencies": {
31
- "mocha": "11.7.5",
32
31
  "should": "13.2.3",
33
- "sinon": "21.0.3"
32
+ "sinon": "22.0.0"
33
+ },
34
+ "engines": {
35
+ "node": ">=20.20.0"
34
36
  },
35
37
  "scripts": {
36
38
  "dv": "node bin/dv.js",
37
39
  "req": "node bin/req.js",
38
40
  "lint": "oxlint -c ../../.oxlintrc.json .",
39
41
  "posttest": "pnpm lint",
40
- "test": "NODE_ENV=testing mocha -- $(find test -name '*.test.js')"
42
+ "test": "NODE_ENV=testing vitest run --coverage"
41
43
  }
42
44
  }