Skip to content

fix(tools): remove special characters from slugs #2460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bennypowers merged 3 commits into from
Mar 30, 2023
Merged

fix(tools): remove special characters from slugs #2460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
75d427e
fix(tools): remove special characters from slug
zeroedin Mar 29, 2023
f65e106
fix(tools): use slugify strict option to enforce no special characters
zeroedin Mar 30, 2023
71eb28a
chore(tools): add changeset
zeroedin Mar 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cuddly-scissors-reply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@patternfly/pfe-tools": patch
---

Removes special characters from component slugs ie. `special (characters)` becomes `special-characters`
2 changes: 1 addition & 1 deletion tools/pfe-tools/11ty/DocsPage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export class DocsPage implements DocsPageRenderer {
private options?: DocsPageOptions) {
this.tagName = options?.tagName ?? '';
this.title = options?.title ?? Manifest.prettyTag(this.tagName);
this.slug = slugify(options?.aliases?.[this.tagName] ?? this.tagName.replace(/^\w+-/, '')).toLowerCase();
this.slug = slugify(options?.aliases?.[this.tagName] ?? this.tagName.replace(/^\w+-/, ''), { strict: true, lower: true });
this.summary = this.manifest.getSummary(this.tagName);
this.description = this.manifest.getDescription(this.tagName);
this.templates = nunjucks.configure(DocsPage.#templatesDir);
Expand Down
5 changes: 4 additions & 1 deletion tools/pfe-tools/custom-elements-manifest/lib/Manifest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import { join } from 'node:path';
import { readFileSync } from 'node:fs';

import { getAllPackages } from './get-all-packages.js';
import slugify from 'slugify';
import { deslugify } from '@patternfly/pfe-tools/config.js';

type PredicateFn = (x: unknown) => boolean;
Expand Down Expand Up @@ -266,7 +267,9 @@ export class Manifest {
const { prettyTag } = Manifest;
return this.getDemos(tagName).map(demo => {
const permalink = demo.url.replace(options.demoURLPrefix, '/');
const [, slug = ''] = permalink.match(/\/components\/(.*)\/demo/) ?? [];
let [, slug = ''] = permalink.match(/\/components\/(.*)\/demo/) ?? [];
// strict removes all special characters from slug
slug = slugify(slug, { strict: true, lower: true });
const primaryElementName = deslugify(slug, options.rootDir);
const filePath = demo.source?.href.replace(options.sourceControlURLPrefix, `${options.rootDir}/`) ?? '';
const [last = ''] = filePath.split('/').reverse();
Expand Down