// Use when debugging, adding features to, or testing changes inside any cozy-* or twake-* library consumed by a Twake/Cozy React frontend app. Forbids hand-editing files under node_modules; directs to the linagora/cozy-libs monorepo and to yarn link or rlink for local testing.
Use when writing or reviewing JavaScript/TypeScript in Twake/Cozy projects. Enforces async/await over Promise chains, null over undefined, error handling contract (null / typed result / throw), function declaration style, strict equality, date handling via Intl/date-fns (never moment.js), AppLinker for redirections (never window.location), and business-logic-only comments.
Use when writing, reviewing, or scaffolding TypeScript in Twake/Cozy projects. Delta over twake-javascript-conventions — read that first. Enforces explicit types and exported types, type vs interface, unknown in catch, satisfies, strict mode, constrained generics, string unions over enums, TC39 decorators, and bans any / as unknown as T / @ts-ignore / unconstrained generics / void without justification.
Use when reading, writing, or designing data access against a Cozy stack from a Twake/Cozy React app — anything touching cozy-client, doctypes, Q(), client.query, useQuery, or client.collection. Forbids direct collection access that bypasses the redux store and offline cache, enforces Q() definitions through client.query/useQuery, mandates a centralized queries module, query alias naming per cozy-guidelines, an explicit fetchPolicy on every query, and the canonical where/partialIndex/indexFields/sortBy/limitBy pattern with the `{ $gt: null }` sentinel for sortBy fields.
Use when writing, reviewing, or refactoring frontend tests in Twake/Cozy React projects. Enforces @testing-library/react (never Enzyme or TestCafe), data-testid attributes, queryBy + toBeInDocument()/toBe(null) patterns, colocated *.spec files (no __tests__ folders), and bans snapshot tests.
Use when writing commit messages, creating branches, or opening pull requests on Linagora/Twake/Cozy projects. Enforces Conventional Commits, one subject per commit (atomic commits), a structured PR workflow (branch, commit, push, gh pr create), lowercase PR titles under 70 chars, and Summary-only PR bodies with no invented motivation and no em dashes.
Use when naming JavaScript/TypeScript functions, variables, cozy-client queries, or organizing imports in Twake/Cozy projects. Enforces function prefixes (fetch/get/find/has/is/compute/make/normalize/save/ensure/doSomethingAndForget), query `as` naming with doctype and params, and external→internal→local import order.
| name | twake-frontend-lib-workflow |
| description | Use when debugging, adding features to, or testing changes inside any cozy-* or twake-* library consumed by a Twake/Cozy React frontend app. Forbids hand-editing files under node_modules; directs to the linagora/cozy-libs monorepo and to yarn link or rlink for local testing. |
Apply these rules whenever you need to change, debug, or experiment with the behavior of a cozy-* or twake-* library (e.g. cozy-ui, cozy-client, cozy-stack-client, twake-mui) from inside a Twake or Cozy React app.
node_modules by handEditing files under node_modules/ directly:
yarn install / npm install.If you find yourself wanting to change a file under node_modules/, stop. Use the workflow below.
Most shared cozy-* libraries live in the cozy-libs monorepo:
https://github.com/linagora/cozy-libs
Look there first. The monorepo uses Yarn workspaces; each package lives under packages/<name>.
If the package is not in cozy-libs, it has its own repository:
cozy-ui → https://github.com/cozy/cozy-uitwake-mui → https://github.com/linagora/twake-uitwake-* libraries → check the linagora GitHub org.Clone the relevant repo before going further.
Use yarn link, or rlink when the library repo ships that helper (it wraps linking plus a watch build).
# In the library checkout (e.g. cozy-libs/packages/cozy-ui)
yarn link
# In your consuming app
cd my-twake-app
yarn link cozy-ui
If the library needs transpilation (most do), start its watch build in parallel so your app picks up source changes on reload.
rlink automates the link and the watch build in one command when it exists in the library repo.
Once the fix works locally:
twake-git-conventions skill (atomic commits, Conventional Commits, structured PR).yarn unlink (or the rlink unlink equivalent) and a fresh yarn install so the app consumes the published version again.Forgetting step 4 will break the app for other developers and for CI, because the linked directory only exists on your machine.
node_modules/cozy-ui/transpiled/... or any other file under node_modules/.cozy-* / twake-* library into the app to "fix it locally".patch-package diff against a cozy-* / twake-* library. The fix belongs upstream.yarn.lock that references a linked directory.yarn unlink before pushing. If CI green-lights an app pointing at a link, the lock has drifted.