jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Remove remaining JSON requires (#20110)

Browse Source 
* Remove remaining JSON requires

* Lint

* Update feature-flags.js
This commit is contained in:
Kevin Heis
2021-06-23 14:57:50 -07:00
committed by GitHub
parent 6f4439a631
commit a92d820888
21 changed files with 63 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
lib/feature-flags.js
View File

@@ -1,4 +1,5 @@
const featureFlags = require('../feature-flags')
const readJsonFile = require('./read-json-file')
const featureFlags = readJsonFile('./feature-flags.json')
// add feature flags as environment variables
Object.entries(featureFlags).forEach(([feature, value]) => {

14
lib/read-json-file.js Normal file
View File

@@ -0,0 +1,14 @@
const fs = require('fs')
const path = require('path')
module.exports = function readJsonFile (xpath) {
return JSON.parse(
fs.readFileSync(
path.join(
process.cwd(),
xpath
),
'utf8'
)
)
}

3
lib/redirects/precompile.js
View File

@@ -1,4 +1,5 @@
const developerRedirects = require('../redirects/static/developer')
const readJsonFile = require('../read-json-file')
const developerRedirects = readJsonFile('./lib/redirects/static/developer.json')
const { latest } = require('../../lib/enterprise-server-releases')
const latestDevRedirects = {}

6
lib/render-content/plugins/rewrite-local-links.js
View File

@@ -1,15 +1,17 @@
const path = require('path')
const visit = require('unist-util-visit')
const externalRedirects = Object.keys(require('../../redirects/external-sites'))
const { getPathWithoutLanguage, getVersionStringFromPath } = require('../../path-utils')
const { getNewVersionedPath } = require('../../old-versions-utils')
const patterns = require('../../patterns')
const { deprecated, latest } = require('../../enterprise-server-releases')
const nonEnterpriseDefaultVersion = require('../../non-enterprise-default-version')
const allVersions = require('../../all-versions')
const removeFPTFromPath = require('../../remove-fpt-from-path')
const supportedVersions = Object.keys(allVersions)
const supportedPlans = Object.values(allVersions).map(v => v.plan)
const removeFPTFromPath = require('../../remove-fpt-from-path')
const readJsonFile = require('../../read-json-file')
const externalRedirects = Object.keys(readJsonFile('./lib/redirects/external-sites.json'))
// Matches any <a> tags with an href that starts with `/`
const matcher = node => (

3
lib/rewrite-local-links.js
View File

@@ -1,6 +1,5 @@
const assert = require('assert')
const path = require('path')
const externalRedirects = Object.keys(require('./redirects/external-sites'))
const { getPathWithoutLanguage, getVersionStringFromPath } = require('./path-utils')
const { getNewVersionedPath } = require('./old-versions-utils')
const patterns = require('./patterns')
@@ -10,6 +9,8 @@ const allVersions = require('./all-versions')
const supportedVersions = Object.keys(allVersions)
const supportedPlans = Object.values(allVersions).map(v => v.plan)
const removeFPTFromPath = require('./remove-fpt-from-path')
const readJsonFile = require('./read-json-file')
const externalRedirects = readJsonFile('./lib/redirects/external-sites.json')
// Content authors write links like `/some/article/path`, but they need to be
// rewritten on the fly to match the current language and page version

2
lib/search/algolia-search.js
View File

@@ -1,6 +1,6 @@
const algoliasearch = require('algoliasearch')
const { get } = require('lodash')
const { namePrefix } = require('./config')
const { namePrefix } = require('./config.js')
// https://www.algolia.com/apps/ZI5KPY1HBE/dashboard
// This API key is public. There's also a private API key for writing to the Algolia API

2
lib/search/lunr-search.js
View File

@@ -8,7 +8,7 @@ require('lunr-languages/lunr.pt')(lunr)
require('lunr-languages/lunr.de')(lunr)
const { get } = require('lodash')
const readFileAsync = require('../readfile-async')
const { namePrefix } = require('./config')
const { namePrefix } = require('./config.js')
const { decompress } = require('./compress')
const LUNR_DIR = './indexes'

5
middleware/archived-enterprise-versions.js
View File

@@ -5,8 +5,9 @@ const patterns = require('../lib/patterns')
const versionSatisfiesRange = require('../lib/version-satisfies-range')
const isArchivedVersion = require('../lib/is-archived-version')
const got = require('got')
const archvivedRedirects = require('../lib/redirects/static/archived-redirects-from-213-to-217')
const archivedFrontmatterFallbacks = require('../lib/redirects/static/archived-frontmatter-fallbacks')
const readJsonFile = require('../lib/read-json-file')
const archvivedRedirects = readJsonFile('./lib/redirects/static/archived-redirects-from-213-to-217.json')
const archivedFrontmatterFallbacks = readJsonFile('./lib/redirects/static/archived-frontmatter-fallbacks.json')
// This module handles requests for deprecated GitHub Enterprise versions
// by routing them to static content in help-docs-archived-enterprise-versions

3
middleware/context.js
View File

@@ -11,7 +11,8 @@ const {
} = require('../lib/path-utils')
const productNames = require('../lib/product-names')
const warmServer = require('../lib/warm-server')
const featureFlags = Object.keys(require('../feature-flags'))
const readJsonFile = require('../lib/read-json-file')
const featureFlags = Object.keys(readJsonFile('./feature-flags.json'))
const builtAssets = require('../lib/built-asset-urls')
const searchVersions = require('../lib/search/versions')
const nonEnterpriseDefaultVersion = require('../lib/non-enterprise-default-version')

11
middleware/contextualizers/graphql.js
View File

@@ -1,10 +1,11 @@
const fs = require('fs')
const path = require('path')
const previews = require('../../lib/graphql/static/previews')
const upcomingChanges = require('../../lib/graphql/static/upcoming-changes')
const changelog = require('../../lib/graphql/static/changelog')
const prerenderedObjects = require('../../lib/graphql/static/prerendered-objects')
const prerenderedInputObjects = require('../../lib/graphql/static/prerendered-input-objects')
const readJsonFile = require('../../lib/read-json-file')
const previews = readJsonFile('./lib/graphql/static/previews.json')
const upcomingChanges = readJsonFile('./lib/graphql/static/upcoming-changes.json')
const changelog = readJsonFile('./lib/graphql/static/changelog.json')
const prerenderedObjects = readJsonFile('./lib/graphql/static/prerendered-objects.json')
const prerenderedInputObjects = readJsonFile('./lib/graphql/static/prerendered-input-objects.json')
const allVersions = require('../../lib/all-versions')
const explorerUrl = process.env.NODE_ENV === 'production'

3
middleware/redirects/external.js
View File

@@ -1,4 +1,5 @@
const externalSites = require('../../lib/redirects/external-sites')
const readJsonFile = require('../../lib/read-json-file')
const externalSites = readJsonFile('./lib/redirects/external-sites.json')
// blanket redirects to external websites
module.exports = function externalRedirects (req, res, next) {

2
script/graphql/update-files.js
View File

@@ -8,7 +8,7 @@ const { execSync } = require('child_process')
const graphqlDataDir = path.join(process.cwd(), 'data/graphql')
const graphqlStaticDir = path.join(process.cwd(), 'lib/graphql/static')
const { getContents, listMatchingRefs } = require('../helpers/git-utils')
const dataFilenames = require('./utils/data-filenames')
const dataFilenames = JSON.parse(fs.readFileSync('./utils/data-filenames.json'))
const allVersions = require('../../lib/all-versions')
const processPreviews = require('./utils/process-previews')
const processUpcomingChanges = require('./utils/process-upcoming-changes')

3
script/graphql/utils/process-schemas.js
View File

@@ -1,8 +1,9 @@
const { sortBy } = require('lodash')
const { parse, buildASTSchema } = require('graphql')
const helpers = require('./schema-helpers')
const fs = require('fs')
const externalScalars = require('../../../lib/graphql/non-schema-scalars')
const externalScalars = JSON.parse(fs.readFileSync('../../../lib/graphql/non-schema-scalars.json'))
.map(scalar => {
scalar.id = helpers.getId(scalar.name)
scalar.href = helpers.getFullLink('scalars', scalar.id)

3
script/graphql/utils/schema-helpers.js
View File

@@ -1,5 +1,6 @@
const renderContent = require('../../../lib/render-content')
const graphqlTypes = require('../../../lib/graphql/types')
const fs = require('fs')
const graphqlTypes = JSON.parse(fs.readFileSync('../../../lib/graphql/types.json'))
const {
isScalarType,
isObjectType,

2
tests/browser/browser.js
View File

@@ -4,7 +4,7 @@ const path = require('path')
const sleep = require('await-sleep')
const { latest } = require('../../lib/enterprise-server-releases')
const languages = require('../../lib/languages')
const featureFlags = JSON.parse(fs.readFileSync(path.join(process.cwd(), '/feature-flags.json')))
const featureFlags = JSON.parse(fs.readFileSync(path.join(process.cwd(), './feature-flags.json')))
describe('homepage', () => {
jest.setTimeout(60 * 1000)

9
tests/content/graphql.js
View File

@@ -1,13 +1,14 @@
const fs = require('fs')
const path = require('path')
const previewsJson = require('../../lib/graphql/static/previews')
const upcomingChangesJson = require('../../lib/graphql/static/upcoming-changes')
const prerenderedObjectsJson = require('../../lib/graphql/static/prerendered-objects')
const readJsonFile = require('../../lib/read-json-file')
const previewsJson = readJsonFile('./lib/graphql/static/previews.json')
const upcomingChangesJson = readJsonFile('./lib/graphql/static/upcoming-changes.json')
const prerenderedObjectsJson = readJsonFile('./lib/graphql/static/prerendered-objects.json')
const { schemaValidator, previewsValidator, upcomingChangesValidator } = require('../../lib/graphql/validator')
const revalidator = require('revalidator')
const allVersions = Object.values(require('../../lib/all-versions'))
const graphqlVersions = allVersions.map(v => v.miscVersionName)
const graphqlTypes = require('../../lib/graphql/types').map(t => t.kind)
const graphqlTypes = readJsonFile('./lib/graphql/types.json').map(t => t.kind)
describe('graphql json files', () => {
jest.setTimeout(3 * 60 * 1000)

5
tests/graphql/build-changelog-test.js
View File

@@ -3,8 +3,9 @@ const { createChangelogEntry, cleanPreviewTitle, previewAnchor, prependDatedEntr
const fs = require('fs').promises
const MockDate = require('mockdate')
const readFileAsync = require('../../lib/readfile-async')
const expectedChangelogEntry = require('../fixtures/changelog-entry')
const expectedUpdatedChangelogFile = require('../fixtures/updated-changelog-file')
const readJsonFile = require('../../lib/read-json-file')
const expectedChangelogEntry = readJsonFile('./tests/fixtures/changelog-entry.json')
const expectedUpdatedChangelogFile = readJsonFile('./tests/fixtures/updated-changelog-file.json')
describe('creating a changelog from old schema and new schema', () => {
afterEach(() => {

7
tests/routing/developer-site-redirects.js
View File

@@ -2,9 +2,10 @@ const path = require('path')
const { eachOfLimit } = require('async')
const enterpriseServerReleases = require('../../lib/enterprise-server-releases')
const { get } = require('../helpers/supertest')
const restRedirectFixtures = require('../fixtures/rest-redirects')
const graphqlRedirectFixtures = require('../fixtures/graphql-redirects')
const developerRedirectFixtures = require('../fixtures/developer-redirects')
const readJsonFile = require('../../lib/read-json-file')
const restRedirectFixtures = readJsonFile('./tests/fixtures/rest-redirects.json')
const graphqlRedirectFixtures = readJsonFile('./tests/fixtures/graphql-redirects.json')
const developerRedirectFixtures = readJsonFile('./tests/fixtures/developer-redirects.json')
const MAX_CONCURRENT_REQUESTS = 50

5
tests/routing/top-developer-site-path-redirects.js
View File

@@ -1,7 +1,6 @@
const fs = require('fs')
const path = require('path')
const { head } = require('../helpers/supertest')
const topOldDeveloperSitePaths = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'tests/fixtures/top-old-developer-site-paths.json')))
const readJsonFile = require('../../lib/read-json-file')
const topOldDeveloperSitePaths = readJsonFile('tests/fixtures/top-old-developer-site-paths.json')
jest.useFakeTimers()

3
tests/unit/feature-flags.js
View File

@@ -1,5 +1,6 @@
require('../../lib/feature-flags')
const ffs = require('../../feature-flags')
const readJsonFile = require('../../lib/read-json-file')
const ffs = readJsonFile('./feature-flags.json')
describe('feature flags', () => {
Object.keys(ffs).forEach(featureName => {

3
tests/unit/page.js
View File

@@ -1,7 +1,8 @@
const path = require('path')
const cheerio = require('cheerio')
const Page = require('../../lib/page')
const prerenderedObjects = require('../../lib/graphql/static/prerendered-objects')
const readJsonFile = require('../../lib/read-json-file')
const prerenderedObjects = readJsonFile('./lib/graphql/static/prerendered-objects.json')
const allVersions = require('../../lib/all-versions')
const enterpriseServerReleases = require('../../lib/enterprise-server-releases')
const nonEnterpriseDefaultVersion = require('../../lib/non-enterprise-default-version')