Skip to content
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.

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

Feat: add non-page plugin positions #839

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
50 changes: 50 additions & 0 deletions packages/velaux-data/src/plugins/consts.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import { join } from "lodash";

export type Marker = string;
export type Position = string

export const Sep = '.'

Check notice

Code scanning / CodeQL

Semicolon insertion

Avoid automated semicolon insertion (90% of all statements in [the enclosing script](1) have an explicit semicolon).
// j accept random number of Maker
const j = (...s: Marker[]): Position => join(s, Sep) as Position;

export const MDefinition: Marker = 'definition';

export const MComponent: Marker = 'component';
export const MTrait: Marker = 'trait';
export const MPolicy: Marker = 'policy';
export const MWorkflowStep: Marker = 'workflow_step';

export const PComponent: Position = j(MDefinition, MComponent);
export const PTrait: Position = j(MDefinition, MTrait);
export const PPolicy: Position = j(MDefinition, MPolicy);
export const PWorkflowStep: Position = j(MDefinition, MWorkflowStep);

// checkPrefix checks if the given position is a prefix of the given position.
function checkPrefix(position: Position, prefix: string): [boolean, string] {
let ok = position.startsWith(prefix);
if (!ok) {
return [false, ""];
}
let name = position.slice(prefix.length + 1);
return [true, name];
}

// isComponent checks if a position is a component. return [true, name] if it is.
export function isComponent(p: Position): [boolean, string] {
return checkPrefix(p, PComponent);
}

// isTrait checks if a position is a trait. return [true, name] if it is.
export function isTrait(p: Position): [boolean, string] {
return checkPrefix(p, PTrait);
}

// isPolicy checks if a position is a policy. return [true, name] if it is.
export function isPolicy(p: Position): [boolean, string] {
return checkPrefix(p, PPolicy);
}

// isWorkflowStep checks if a position is a workflow step. return [true, name] if it is.
export function isWorkflowStep(p: Position): [boolean, string] {
return checkPrefix(p, PWorkflowStep);
}