[wip] [mentions] feat: tag mentions #3688
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| import getCleanDisplayName, { shouldUseOldFormat } from './getCleanDisplayName'; | ||
| import type User from 'flarum/common/models/User'; | ||
| import type Group from 'flarum/common/models/Group'; | ||
|
|
||
| /** | ||
| * Fetches the mention text for a specified model. | ||
| */ | ||
| export default class MentionTextGenerator { | ||
| /** | ||
| * Automatically determines which mention syntax to be used based on the option in the | ||
| * admin dashboard. Also performs display name clean-up automatically. | ||
| * | ||
| * @"Display name"#UserID or `@username` | ||
| * | ||
| * @example <caption>New display name syntax</caption> | ||
| * // '@"user"#1' | ||
| * forUser(User) // User is ID 1, display name is 'User' | ||
| * | ||
| * @example <caption>Using old syntax</caption> | ||
| * // '@username' | ||
| * forUser(user) // User's username is 'username' | ||
| * | ||
| * @param user | ||
| * @returns string | ||
| */ | ||
| forUser(user: User): string { | ||
| if (shouldUseOldFormat()) { | ||
| const cleanText = getCleanDisplayName(user, false); | ||
| return `@${cleanText}`; | ||
| } | ||
| const cleanText = getCleanDisplayName(user); | ||
| return `@"${cleanText}"#${user.id()}`; | ||
| } | ||
|
|
||
| /** | ||
| * Generates the syntax for mentioning of a post. Also cleans up the display name. | ||
| * | ||
| * @example <caption>Post mention</caption> | ||
| * // '@"User"#p13' | ||
| * // @"Display name"#pPostID | ||
| * forPostMention(user, 13) // User display name is 'User', post ID is 13 | ||
| * | ||
| * @param user | ||
| * @param postId | ||
| * @returns | ||
| */ | ||
| forPostMention(user: User, postId: number): string { | ||
| const cleanText = getCleanDisplayName(user); | ||
| return `@"${cleanText}"#p${postId}`; | ||
| } | ||
|
|
||
| /** | ||
| * Generates the mention syntax for a group mention. | ||
| * | ||
| * @"Name Plural"#gGroupID | ||
| * | ||
| * @example <caption>Group mention</caption> | ||
| * // '@"Mods"#g4' | ||
| * forGroup(group) // Group display name is 'Mods', group ID is 4 | ||
| * | ||
| * @param group | ||
| * @returns string | ||
| */ | ||
| forGroup(group: Group): string { | ||
| return `@"${group.namePlural()}"#g${group.id()}`; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| { | ||
| // Use Flarum's tsconfig as a starting point | ||
| "extends": "flarum-tsconfig", | ||
| // This will match all .ts, .tsx, .d.ts, .js, .jsx files in your `src` folder | ||
| // and also tells your Typescript server to read core's global typings for | ||
| // access to `dayjs` and `$` in the global namespace. | ||
| "include": [ | ||
| "src/**/*", | ||
| "../../../framework/core/js/dist-typings/@types/**/*", | ||
| "@types/**/*" | ||
| ], | ||
| "compilerOptions": { | ||
| // This will output typings to `dist-typings` | ||
| "declarationDir": "./dist-typings", | ||
| "paths": { | ||
| "flarum/*": [ | ||
| "../../../framework/core/js/dist-typings/*" | ||
| ], | ||
| // TODO: remove after export registry system implemented | ||
| // Without this, the old-style `@flarum/core` import is resolved to | ||
| // source code in flarum/core instead of the dist typings. | ||
| // This causes an inaccurate "duplicate export" error. | ||
| "@flarum/core/*": [ | ||
| "../../../framework/core/js/dist-typings/*" | ||
| ], | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
following my previous comment