From 53949b668a20180c1985eff0e7b491fa1e0c059d Mon Sep 17 00:00:00 2001 From: ThatOneCalculator Date: Thu, 19 Oct 2023 17:01:02 -0700 Subject: [PATCH] docs: :memo: Misskey -> Firefish in documentation/comments/WebAuthn name --- CONTRIBUTING.md | 17 +++++------------ chart/templates/_helpers.tpl | 6 +++--- cypress/e2e/basic.cy.js | 4 ++-- packages/backend/src/index.ts | 2 +- .../src/remote/activitypub/db-resolver.ts | 8 ++++---- packages/client/src/pages/settings/2fa.vue | 2 +- packages/firefish-js/src/streaming.ts | 2 +- 7 files changed, 17 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9529ea73..743eaef00 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,9 +94,9 @@ An actual domain will be assigned so you can test the federation. - The tag name must be the version ## Development -During development, it is useful to use the `yarn dev` command. +During development, it is useful to use the `pnpm run dev` command. This command monitors the server-side and client-side source files and automatically builds them if they are modified. -In addition, it will also automatically start the Misskey server process. +In addition, it will also automatically start the Firefish server process. ## Testing - Test codes are located in [`/test`](/test). @@ -119,20 +119,13 @@ yarn test #### Run specify test ``` -TS_NODE_FILES=true TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT="./test/tsconfig.json" yarn dlx mocha test/foo.ts --require ts-node/register +TS_NODE_FILES=true TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT="./test/tsconfig.json" pnpx mocha test/foo.ts --require ts-node/register ``` -### e2e tests -TODO - -## Continuous integration -Misskey uses GitHub Actions for executing automated tests. -Configuration files are located in [`/.github/workflows`](/.github/workflows). - ## Vue -Misskey uses Vue(v3) as its front-end framework. +Firefish uses Vue(v3) as its front-end framework. - Use TypeScript. -- **When creating a new component, please use the Composition API (with [setup sugar](https://v3.vuejs.org/api/sfc-script-setup.html) and [ref sugar](https://github.com/vuejs/rfcs/discussions/369)) instead of the Options API.** +- **When creating a new component, please use the Composition API (with [setup syntax](https://v3.vuejs.org/api/sfc-script-setup.html) and [ref syntax](https://github.com/vuejs/rfcs/discussions/369)) instead of the Options API.** - Some of the existing components are implemented in the Options API, but it is an old implementation. Refactors that migrate those components to the Composition API are also welcome. ## nirax diff --git a/chart/templates/_helpers.tpl b/chart/templates/_helpers.tpl index 1b23250a8..215d209ee 100644 --- a/chart/templates/_helpers.tpl +++ b/chart/templates/_helpers.tpl @@ -98,11 +98,11 @@ url: "https://{{ .Values.firefish.domain }}/" #───┘ Port and TLS settings └─────────────────────────────────── # -# Misskey requires a reverse proxy to support HTTPS connections. +# Firefish requires a reverse proxy to support HTTPS connections. # # +----- https://example.tld/ ------------+ # +------+ |+-------------+ +----------------+| -# | User | ---> || Proxy (443) | ---> | Misskey (3000) || +# | User | ---> || Proxy (443) | ---> | Firefish (3000) || # +------+ |+-------------+ +----------------+| # +---------------------------------------+ # @@ -110,7 +110,7 @@ url: "https://{{ .Values.firefish.domain }}/" # An encrypted connection with HTTPS is highly recommended # because tokens may be transferred in GET requests. -# The port that your Misskey server should listen on. +# The port that your Firefish server should listen on. port: 3000 # ┌──────────────────────────┐ diff --git a/cypress/e2e/basic.cy.js b/cypress/e2e/basic.cy.js index f73a25efb..295f41999 100644 --- a/cypress/e2e/basic.cy.js +++ b/cypress/e2e/basic.cy.js @@ -139,10 +139,10 @@ describe("After user singed in", () => { it("note", () => { cy.get("[data-cy-open-post-form]").click(); - cy.get("[data-cy-post-form-text]").type("Hello, Misskey!"); + cy.get("[data-cy-post-form-text]").type("Hello, Firefish!"); cy.get("[data-cy-open-post-form-submit]").click(); - cy.contains("Hello, Misskey!"); + cy.contains("Hello, Firefish!"); }); }); diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts index 278f630f7..33b5826a7 100644 --- a/packages/backend/src/index.ts +++ b/packages/backend/src/index.ts @@ -1,5 +1,5 @@ /** - * Misskey Entry Point! + * Firefish Entry Point */ import { EventEmitter } from "node:events"; diff --git a/packages/backend/src/remote/activitypub/db-resolver.ts b/packages/backend/src/remote/activitypub/db-resolver.ts index 39f3c6e43..a753606a1 100644 --- a/packages/backend/src/remote/activitypub/db-resolver.ts +++ b/packages/backend/src/remote/activitypub/db-resolver.ts @@ -70,7 +70,7 @@ export function parseUri(value: string | IObject): UriParseResult { export default class DbResolver { /** - * AP Note => Misskey Note in DB + * AP Note => Firefish Note in DB */ public async getNoteFromApId(value: string | IObject): Promise { const parsed = parseUri(value); @@ -114,7 +114,7 @@ export default class DbResolver { } /** - * AP Person => Misskey User in DB + * AP Person => Firefish User in DB */ public async getUserFromApId( value: string | IObject, @@ -147,7 +147,7 @@ export default class DbResolver { } /** - * AP KeyId => Misskey User and Key + * AP KeyId => Firefish User and Key */ public async getAuthUserFromKeyId(keyId: string): Promise<{ user: CacheableRemoteUser; @@ -181,7 +181,7 @@ export default class DbResolver { } /** - * AP Actor id => Misskey User and Key + * AP Actor id => Firefish User and Key */ public async getAuthUserFromApId(uri: string): Promise<{ user: CacheableRemoteUser; diff --git a/packages/client/src/pages/settings/2fa.vue b/packages/client/src/pages/settings/2fa.vue index 0caacdc60..2bf07e03b 100644 --- a/packages/client/src/pages/settings/2fa.vue +++ b/packages/client/src/pages/settings/2fa.vue @@ -279,7 +279,7 @@ async function addSecurityKey() { challenge: byteify(challenge.challenge, "base64"), rp: { id: hostname, - name: "Misskey", + name: "Firefish", }, user: { id: byteify($i!.id, "ascii"), diff --git a/packages/firefish-js/src/streaming.ts b/packages/firefish-js/src/streaming.ts index e6aa76dec..4697acabd 100644 --- a/packages/firefish-js/src/streaming.ts +++ b/packages/firefish-js/src/streaming.ts @@ -47,7 +47,7 @@ type StreamEvents = { } & BroadcastEvents; /** - * Misskey stream connection + * Firefish stream connection */ export default class Stream extends EventEmitter { private stream: ReconnectingWebsocket;