mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-04-15 03:01:37 -05:00
Added @tryghost/custom-fonts module
This commit is contained in:
Aileen Booker
parent
737cf35e71
commit
f79b230690
12 changed files with 248 additions and 38 deletions
|
|
@ -49,6 +49,7 @@
|
|||
"@testing-library/react": "14.3.1",
|
||||
"@tryghost/admin-x-design-system": "0.0.0",
|
||||
"@tryghost/admin-x-framework": "0.0.0",
|
||||
"@tryghost/custom-fonts": "0.0.0",
|
||||
"@types/react": "18.3.3",
|
||||
"@types/react-dom": "18.3.0",
|
||||
"@types/validator": "13.12.0",
|
||||
|
|
|
|||
|
|
@ -43,14 +43,12 @@ const BrandSettings: React.FC<{ values: BrandSettingValues, updateSetting: (key:
|
|||
'Mulish',
|
||||
'PT Serif',
|
||||
'Raleway',
|
||||
'Mona Sans',
|
||||
'Open Sans',
|
||||
'JetBrains Mono',
|
||||
'Libre Baskerville',
|
||||
'Manrope',
|
||||
'Poppins',
|
||||
'EB Garamond'
|
||||
].map(x => {
|
||||
].map((x) => {
|
||||
return {
|
||||
label: x,
|
||||
value: x
|
||||
|
|
@ -81,9 +79,8 @@ const BrandSettings: React.FC<{ values: BrandSettingValues, updateSetting: (key:
|
|||
selectedOption={selectedCustomFont}
|
||||
title={'Paragraph Font'}
|
||||
onSelect={(option) => {
|
||||
console.log('updateSetting', option?.value);
|
||||
setBlah(option?.value);
|
||||
updateSetting('paragraph_font', option?.value || null)
|
||||
setBlah(option?.value || '');
|
||||
updateSetting('paragraph_font', option?.value || null);
|
||||
}}
|
||||
/>
|
||||
<ColorPickerField
|
||||
|
|
|
|||
|
|
@ -22,7 +22,12 @@ export default (function viteConfig() {
|
|||
}
|
||||
},
|
||||
optimizeDeps: {
|
||||
include: ['@tryghost/kg-unsplash-selector']
|
||||
include: ['@tryghost/kg-unsplash-selector', '@tryghost/custom-fonts']
|
||||
}
|
||||
},
|
||||
build: {
|
||||
commonjsOptions: {
|
||||
include: [/ghost\/custom-fonts/]
|
||||
}
|
||||
}
|
||||
});
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
// Outputs scripts and other assets at the top of a Ghost theme
|
||||
const {labs, metaData, settingsCache, config, blogIcon, urlUtils, getFrontendKey} = require('../services/proxy');
|
||||
const {escapeExpression, SafeString} = require('../services/handlebars');
|
||||
|
||||
const {generateCustomFontCss, isValidCustomFont} = require('@tryghost/custom-fonts');
|
||||
// BAD REQUIRE
|
||||
// @TODO fix this require
|
||||
const {cardAssets} = require('../services/assets-minification');
|
||||
|
|
@ -341,8 +341,8 @@ module.exports = async function ghost_head(options) { // eslint-disable-line cam
|
|||
}
|
||||
|
||||
const paragraphFont = settingsCache.get('paragraph_font');
|
||||
if (paragraphFont) {
|
||||
head.push(customFontCss(paragraphFont));
|
||||
if (typeof paragraphFont === 'string' && isValidCustomFont(paragraphFont)) {
|
||||
head.push(generateCustomFontCss(paragraphFont));
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -356,32 +356,4 @@ module.exports = async function ghost_head(options) { // eslint-disable-line cam
|
|||
}
|
||||
};
|
||||
|
||||
function customFontCss(font) {
|
||||
if (!font) {
|
||||
return;
|
||||
}
|
||||
const importStrings = {
|
||||
'EB Garamond': '@import url(https://fonts.bunny.net/css?family=eb-garamond:400);',
|
||||
'Inter': '@import url(https://fonts.bunny.net/css?family=inter:400);',
|
||||
'JetBrains Mono': '@import url(https://fonts.bunny.net/css?family=jetbrains-mono:400);',
|
||||
'Libre Baskerville': '@import url(https://fonts.bunny.net/css?family=libre-baskerville:400);',
|
||||
'Lora': '@import url(https://fonts.bunny.net/css?family=lora:400);',
|
||||
'Mulish': '@import url(https://fonts.bunny.net/css?family=mulish:400);',
|
||||
'Open Sans': '@import url(https://fonts.bunny.net/css?family=open-sans:400);',
|
||||
'Poppins': '@import url(https://fonts.bunny.net/css?family=poppins:400);',
|
||||
'PT Serif': '@import url(https://fonts.bunny.net/css?family=pt-serif:400);',
|
||||
'Raleway': '@import url(https://fonts.bunny.net/css?family=raleway:400);',
|
||||
};
|
||||
|
||||
return `
|
||||
<style>
|
||||
${importStrings[font]}
|
||||
|
||||
p {
|
||||
font-family: ${font};
|
||||
}
|
||||
</style>
|
||||
`;
|
||||
}
|
||||
|
||||
module.exports.async = true;
|
||||
|
|
|
|||
|
|
@ -80,6 +80,7 @@
|
|||
"@tryghost/debug": "0.1.32",
|
||||
"@tryghost/domain-events": "0.0.0",
|
||||
"@tryghost/donations": "0.0.0",
|
||||
"@tryghost/custom-fonts": "0.0.0",
|
||||
"@tryghost/dynamic-routing-events": "0.0.0",
|
||||
"@tryghost/email-analytics-provider-mailgun": "0.0.0",
|
||||
"@tryghost/email-analytics-service": "0.0.0",
|
||||
|
|
|
|||
7
ghost/custom-fonts/.eslintrc.js
Normal file
7
ghost/custom-fonts/.eslintrc.js
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
module.exports = {
|
||||
parser: '@typescript-eslint/parser',
|
||||
plugins: ['ghost'],
|
||||
extends: [
|
||||
'plugin:ghost/node'
|
||||
]
|
||||
};
|
||||
23
ghost/custom-fonts/README.md
Normal file
23
ghost/custom-fonts/README.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
# Custom Fonts
|
||||
|
||||
Custom fonts mapping module
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
## Develop
|
||||
|
||||
This is a monorepo package.
|
||||
|
||||
Follow the instructions for the top-level repo.
|
||||
1. `git clone` this repo & `cd` into it as usual
|
||||
2. Run `yarn` to install top-level dependencies.
|
||||
|
||||
|
||||
|
||||
## Test
|
||||
|
||||
- `yarn lint` run just eslint
|
||||
- `yarn test` run lint and tests
|
||||
|
||||
31
ghost/custom-fonts/package.json
Normal file
31
ghost/custom-fonts/package.json
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
{
|
||||
"name": "@tryghost/custom-fonts",
|
||||
"version": "0.0.0",
|
||||
"repository": "https://github.com/TryGhost/Ghost/tree/main/packages/custom-fonts",
|
||||
"author": "Ghost Foundation",
|
||||
"private": true,
|
||||
"main": "build/index.js",
|
||||
"types": "build/index.d.ts",
|
||||
"scripts": {
|
||||
"dev": "tsc --watch --preserveWatchOutput --sourceMap",
|
||||
"build": "tsc",
|
||||
"prepare": "tsc",
|
||||
"test:unit": "NODE_ENV=testing c8 --src src --all --check-coverage --100 --reporter text --reporter cobertura mocha -r ts-node/register './test/**/*.test.ts'",
|
||||
"test": "yarn test:types && yarn test:unit",
|
||||
"test:types": "tsc --noEmit",
|
||||
"lint:code": "eslint src/ --ext .ts --cache",
|
||||
"lint": "yarn lint:code && yarn lint:test",
|
||||
"lint:test": "eslint -c test/.eslintrc.js test/ --ext .ts --cache"
|
||||
},
|
||||
"files": [
|
||||
"build"
|
||||
],
|
||||
"devDependencies": {
|
||||
"c8": "10.1.2",
|
||||
"mocha": "10.7.3",
|
||||
"sinon": "19.0.2",
|
||||
"ts-node": "10.9.2",
|
||||
"typescript": "5.6.2"
|
||||
},
|
||||
"dependencies": {}
|
||||
}
|
||||
48
ghost/custom-fonts/src/index.ts
Normal file
48
ghost/custom-fonts/src/index.ts
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
type Font = 'EB Garamond' | 'Inter' | 'JetBrains Mono' | 'Libre Baskerville' | 'Lora' | 'Mulish' | 'Open Sans' | 'Poppins' | 'PT Serif' | 'Raleway';
|
||||
|
||||
export function generateCustomFontCss(font: Font) {
|
||||
const importStrings = {
|
||||
'EB Garamond': '@import url(https://fonts.bunny.net/css?family=eb-garamond:400);',
|
||||
Inter: '@import url(https://fonts.bunny.net/css?family=inter:400);',
|
||||
'JetBrains Mono': '@import url(https://fonts.bunny.net/css?family=jetbrains-mono:400);',
|
||||
'Libre Baskerville': '@import url(https://fonts.bunny.net/css?family=libre-baskerville:400);',
|
||||
Lora: '@import url(https://fonts.bunny.net/css?family=lora:400);',
|
||||
Mulish: '@import url(https://fonts.bunny.net/css?family=mulish:400);',
|
||||
'Open Sans': '@import url(https://fonts.bunny.net/css?family=open-sans:400);',
|
||||
Poppins: '@import url(https://fonts.bunny.net/css?family=poppins:400);',
|
||||
'PT Serif': '@import url(https://fonts.bunny.net/css?family=pt-serif:400);',
|
||||
Raleway: '@import url(https://fonts.bunny.net/css?family=raleway:400);'
|
||||
};
|
||||
|
||||
return `
|
||||
<style>
|
||||
${importStrings[font]}
|
||||
|
||||
p {
|
||||
font-family: ${font};
|
||||
}
|
||||
</style>
|
||||
`;
|
||||
}
|
||||
|
||||
// Main module file
|
||||
export const CUSTOM_FONTS: Font[] = [
|
||||
'Inter',
|
||||
'Lora',
|
||||
'Mulish',
|
||||
'PT Serif',
|
||||
'Raleway',
|
||||
'Open Sans',
|
||||
'JetBrains Mono',
|
||||
'Libre Baskerville',
|
||||
'Poppins',
|
||||
'EB Garamond'
|
||||
];
|
||||
|
||||
export function getCustomFonts(): Font[] {
|
||||
return CUSTOM_FONTS;
|
||||
}
|
||||
|
||||
export function isValidCustomFont(font: string): font is Font {
|
||||
return CUSTOM_FONTS.includes(font as Font);
|
||||
}
|
||||
7
ghost/custom-fonts/test/.eslintrc.js
Normal file
7
ghost/custom-fonts/test/.eslintrc.js
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
module.exports = {
|
||||
parser: '@typescript-eslint/parser',
|
||||
plugins: ['ghost'],
|
||||
extends: [
|
||||
'plugin:ghost/test'
|
||||
]
|
||||
};
|
||||
8
ghost/custom-fonts/test/hello.test.ts
Normal file
8
ghost/custom-fonts/test/hello.test.ts
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
import assert from 'assert/strict';
|
||||
|
||||
describe('Hello world', function () {
|
||||
it('Runs a test', function () {
|
||||
// TODO: Write me!
|
||||
assert.ok(require('../'));
|
||||
});
|
||||
});
|
||||
110
ghost/custom-fonts/tsconfig.json
Normal file
110
ghost/custom-fonts/tsconfig.json
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
{
|
||||
"compilerOptions": {
|
||||
/* Visit https://aka.ms/tsconfig to read more about this file */
|
||||
|
||||
/* Projects */
|
||||
"incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
|
||||
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
|
||||
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
|
||||
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
|
||||
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
|
||||
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
|
||||
|
||||
/* Language and Environment */
|
||||
"target": "es6", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
|
||||
// "lib": ["es2019"], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
|
||||
// "jsx": "preserve", /* Specify what JSX code is generated. */
|
||||
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
|
||||
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
|
||||
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
|
||||
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
|
||||
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
|
||||
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
|
||||
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
|
||||
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
|
||||
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
|
||||
|
||||
/* Modules */
|
||||
"module": "commonjs", /* Specify what module code is generated. */
|
||||
"rootDir": "src", /* Specify the root folder within your source files. */
|
||||
"moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
|
||||
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
|
||||
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
|
||||
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
|
||||
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
|
||||
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
|
||||
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
||||
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
|
||||
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
|
||||
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
|
||||
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
|
||||
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
|
||||
"resolveJsonModule": true, /* Enable importing .json files. */
|
||||
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
|
||||
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
|
||||
|
||||
/* JavaScript Support */
|
||||
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
|
||||
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
|
||||
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
|
||||
|
||||
/* Emit */
|
||||
"declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
|
||||
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
|
||||
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
|
||||
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
|
||||
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
|
||||
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
|
||||
"outDir": "build", /* Specify an output folder for all emitted files. */
|
||||
// "removeComments": true, /* Disable emitting comments. */
|
||||
// "noEmit": true, /* Disable emitting files from a compilation. */
|
||||
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
|
||||
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
|
||||
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
|
||||
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
|
||||
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
||||
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
|
||||
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
|
||||
// "newLine": "crlf", /* Set the newline character for emitting files. */
|
||||
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
|
||||
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
|
||||
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
|
||||
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
|
||||
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
|
||||
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
|
||||
|
||||
/* Interop Constraints */
|
||||
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
|
||||
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
|
||||
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
|
||||
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
|
||||
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
|
||||
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
|
||||
|
||||
/* Type Checking */
|
||||
"strict": true, /* Enable all strict type-checking options. */
|
||||
"noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
|
||||
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
|
||||
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
|
||||
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
|
||||
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
|
||||
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
|
||||
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
|
||||
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
|
||||
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
|
||||
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
|
||||
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
|
||||
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
|
||||
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
|
||||
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
|
||||
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
|
||||
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
|
||||
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
|
||||
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
|
||||
|
||||
/* Completeness */
|
||||
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
|
||||
"skipLibCheck": true /* Skip type checking all .d.ts files. */
|
||||
},
|
||||
"include": ["src/**/*"]
|
||||
}
|
||||
Loading…
Add table
Reference in a new issue