mirror of
https://github.com/directus/directus.git
synced 2026-01-14 13:58:15 -05:00
v11.10.0
23 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
Hugo Torzuoli
|
a30f8b8152 | docs: update codebase overview packages list (#23478) | ||
|
Rijk van Zanten
|
2273480c6d |
Implement the new permissions policy (#22773)
* WIP start on migrations
* Add migration
* Don't insert if there's no rows
* Use service to read/write permissions
* Use payload service rather than itemsservice
* Start on downgrade command
* Update system data structure
* Update migrations to keep structure flat
* Remove icon from policies
* Drop policies table on downgrade
* Rearchitect migrations to structure v3
* Add down migration
* Update system fields
* Add policy to fields import
* Fix public role attachment
* Update packages/system-data/src/fields/index.ts
Co-authored-by: Daniel Biegler <DanielBiegler@users.noreply.github.com>
* Update packages/system-data/src/fields/policies.yaml
Co-authored-by: Daniel Biegler <DanielBiegler@users.noreply.github.com>
* Add nested roles
* Remove unused step
* Use two o2ms instead of m2a for attachments
* Update system data
* Implement permission policies in the API (#22384)
* Update system data structure
* Update migrations to keep structure flat
* Remove icon from policies
* Drop policies table on downgrade
* Rearchitect migrations to structure v3
* Add down migration
* Update system fields
* Add policy to fields import
* Fix public role attachment
* Update packages/system-data/src/fields/index.ts
Co-authored-by: Daniel Biegler <DanielBiegler@users.noreply.github.com>
* Update packages/system-data/src/fields/policies.yaml
Co-authored-by: Daniel Biegler <DanielBiegler@users.noreply.github.com>
* Add nested roles
* Remove unused step
* Use two o2ms instead of m2a for attachments
* Update system data
* [WIP] Start reorging permissions handling
* Setup field extraction
* Remove watch from vitest
* Finish fieldMap creation logic
* Add tests for utils
* Improve tests
* Improve coverage
* Split test and test:watch
* Continue on this fun
* [WIP] Setup processing
* Sort roles
* Restructure to util files for org
* Add missing util tests
* More tests
* Add cases/whencase to ast
* Start on injection logic
* Add tests for inject cases
* Add tests for process
* Add todo
* Organize run-ast
* Add clear method to kv
* Remove reliance on acc.perm
* Restructure permissions setup
* Drop perm from acc, add roles/policies
* Remove get-permissions in middleware
* Remove/comment use of acc.perm
* Add default roles/permissions
* Use knex
So we don't have to initialize the schema before we want to use the accountability system
* Use new fetching logic in get accountability
* Add new fetch global access utils
* Gotta redo based on new setup
* Replaced with new util
* Remove dropping of perm in acc
It's no longer there by default, so no need to remove here
* Temporarily comment out the enforce tfa check
* Update usage of fetch tree to use knex
* Don't store policies on accountability
* Feed in roles thru acc
* Bit of whitespace
* Rename role->policy
* Wreck some more stuff
Jk, this is splitting up the large get-ast-from-query function into smaller individual functions to make it easier to update the wildcard conversion to use permissions
* Add ability to lookup all allowed fields in col+ac
* Add note so I don't forget stuff which i will
* Handle null acc
* Introduce parseAst to itemsservice
* That cleans things up
* Replace checkAccess with validateAccess
* Remove checkaccess from service
* cleanup imports
* Whoops one more
* Leave crumbs for next time
* Implement most of the fn
* Fix various tests
* Start on test for fetch roles tree
* Add tests for fetch roles tree
* Fix process tests
* All. of. the. tests.
* Update uses of validateAccess
* Fix name in runAst
* Fix use of accountability in gql sub
* Deprecate authorization service
* Remove getPermissions use
* Drop old getpermissions
* Pass services
* Replace admin/app uses with fetch global
* Update fetch user count to pull from policies
* Remove broken admin existence checks
* Update min accountability
* Remove unused import
* Drop permissions override from controller
* Refactor reliance on acc.perm
* Replace usage of permissions in fields
* Replace usage of permissions in import/export
* Drop permissions use from relations
* Drop no longer used method
* Remove unused import
* fix type usage of pk in validate
* Fix default acc in user
* Replace use of permissions in utils
* Update reduceSchema in specs/gql
* Remove old share merging
* Remove empty file
* Remove outdated comment
* Use ctx objects for large param fns
* Add with-cache memoize util
* Add cache to fetchpermissions
* Update caching use in fetchRolesTree
* Add caching to fetchAllowedFieldMap
* Add more cache
* Refactor call signatures
* Move call signature updates
* Handle presets
* Update process call sig
* Prevent infinite recursion in roles tree lookup
* Use create util for acc
* Remove old checkIp
* Fix where equality operator
* Break EVERYTHING!
Jk just cleaning up the structure some more, and removing the dep injection in favor of mocking
* Fix build
* Add missing module tests
* Don't crash on missing parent
* Fix role lookup
* add missing type annotation
* use logical-OR assignment and avoid a memory allocation
* Attach admin policy in default admin creation
* Fix admin check
* Add todo for later
* rm code duplication
* fix test
it was missing the new `roles`
* add types and fix type error
policies dont [yet] have an icon
* move spread order to avoid potential future mishaps
new default keys would override the manually set keys, potentially leading to unintended behavior
* reduce allocations, add escape hatch to loop and type db-row
* Implement case/when
* Clean up comments
* Optimize perm fetching in allowed f
* Move apply case when to util fn
* Optimize fetch-allowed-fields
* Add fetch inconsistent util
* Allow nulls
* Remove obsolete getCacheKey
* Remove unused import
* Update getAccountabilityForRole test
* Update fetchGlobalAccess test with one more test case + fix other test case
* Type cleanup
* Fix "admin access means automatic app access" in fetchGlobalAccessForQuery
* Clean up and expand fetch-inconsistent-field-map.test.ts
* Test uncached functions
* Test uncached
* Remove cases usage in parse-current-level
* Only consider non-null rules in inject cases
* Fix parseCurrentLevel call
* Move service imports into functions to avoid circular imports
* Ensure that we test that an error is thrown in processAst test
* Add failing test case for flattenFilter
* Ensure uniqueness in extractPathsFromQuery
* Early exit in validatePath
* Add additional test case for process payload test
* Update validateCollectionAccess test
* Clean up validate-item-access.test.ts
* Remove redundant initializer
* Use createDefaultAccountability
* Fix fetch-user-count.test.ts
* Cleanup unused default initializer
* Add empty cases to subfilter in _relationCount
* Drop AccessService and PermissionsService usage from services
* Found some more PermissionsServices
* Fix a few more tests
* Add nested role relation
* Fix query invocation in aggregate and group queries
* Fix role property name in auth/refresh
* Add some missing relations for permissions, access and roles
* Add m2o relation from permissions to policy
* Add m2o relation access to role, user, policy
* Allow fetchPermissions to fetch all permissions and not just those limited by an action
* Add parent to Role type
* Make sure that admin users see all fields
* Add access and policies controller, add util methods to policies and access service
* Change name and description of public policy, update description of admin policy and add on delete trigger.
* Make sure access row uuids are auto generated
* optimize kvredis clear function and add a unit test
to be fair: unit test is also testing implementation details but thats a problem there in general and for future us
* Add minimal app permission and dynamic variable injection to the permission fetching
* Fix m2o collection name in extractFieldsFromChildren
* Make sure to clone permission before injecting dynamic variables
* Actually do the cloning in with withAppMinimalPermissions since people might missbehave with the permissions obtained from PermissionsService.readByQuery so it better to go the source of the problem
* Use knex transaction in createOne -> processPayload - otherwise deadlock
* Make sure to respect '*' field in allowed fields
* Fix extractFieldsFromChildren for o2m as well - classic
* Fix allowed field check in `FieldsService.readAll` to account for multiple permissions for collection+action
* Skip case/when if `allowedFields` includes '*'
* Restructure the way the current users permissions are returned
* add ability to clear all keys from memory cache
* add test for clear method
* add await to clear function
* Clear permissions caches on changes to policy attachments (directus_access) and policy updates (directus_policies) and permissions updates (directus_permissions)
* Make the public role a real role rather than a virtual one
* Inject the public role, we're it previously was `null`
* Revert adding a fix public role
* remove unused variable
* Ensure that a user without a role can still use the /me util endpoints
* Make sure that the /me endpoints always return minimal information, similar to /users/me
* Some fixes after merging main
* Update api/src/permissions/utils/with-cache.ts
Co-authored-by: Hannes Küttner <4376726+hanneskuettner@users.noreply.github.com>
* Avoid broken role query for now
* Skip related collection `parseFields` if user has no permissions
* Ensure same call order as in `convertWildcards`
* Create default admin policy and connect it in cli init command
* Remove obsolete middleware mock in app.test.ts
* Add validation against non-existent fields and collections to `validatePath`
* Split up permission and path existence validation and validate path existence for admin users as well
* Make applySearch not async
* Fix relation extraction and permissions for `$FOLLOW` fields
* Fix case when for related collections and query wrapping
* Rework user integrity checks for Auditus (#22737)
* Changes to user counting and integrity checks
* Ensure that user validation happens in both create one and create many
* Rename `checkType` to `flags`
* Update api/src/permissions/modules/validate-remaining-admin/validate-remaining-admin-count.ts
Co-authored-by: Daniel Biegler <DanielBiegler@users.noreply.github.com>
* Update to enum usage
Co-authored-by: Daniel Biegler <DanielBiegler@users.noreply.github.com>
* A few more changes to enum instead of number
* One more enum type update
* Make sure to correctly override the callback when combining options
* Clean up option type
* Update api/src/services/users.ts
Co-authored-by: ian <licitdev@gmail.com>
* Only take validation shortcut for users
We can only be sure that the deletion of users does not increase any other access types count, so in all other cases we need to verify that for example the App or API users have not increased over the limit
* Make both app and admin users count against app access limit
* Update api/src/permissions/modules/validate-remaining-admin/validate-remaining-admin-count.ts
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
* One post-merge fix, two small fixes
* Simplify flag updating and callback calling
* Changing app access in a policy only requires user limit checking, not full check
* Only the status of a created user should matter to determine if a check is neccessary
* Add count alias to count query
---------
Co-authored-by: Daniel Biegler <DanielBiegler@users.noreply.github.com>
Co-authored-by: ian <licitdev@gmail.com>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
* Add roles and permissions to the app (#22654)
* Initial app changes
* Fix getRelationsForField
* Add changeset
* Remove app-permissions from role settings
* Make sure access row uuids are auto generated
* Move a few things around, set up policies m2m properly
* Show roles as tree in sidebar
Change avatar field query for user
* Show user and role count in policy table
* Default to not adding app access for a policy, makes composability less annoying
* Correctly fall back to 0 for counts
* Change the structure of current user permissions
* Start bringing back the public role
* Make the public role a real role rather than a virtual one
* Revert public role changes
* Extend list-m2m to allow for very custom junction matching and a primary key of `null`
* Remove unused
* Fix public role policy update payload
* Fix app access for users without role (which is a thing now apparently)
* Make sure that the /me endpoints always return minimal information, similar to /users/me
* Tweak nav icons
* Pull policy id from constants
* Update permissions interface design to match
New design language in figma
* Some minor adjustments
- Make chip hover border more consistent
- Add "Remove" button to remove a full row of permissions, as in the UI mockup
- Fix table layout
* Clean up a few more things
* Fix `setFullAccess`
* Align collection view icons with navigation
* Don't query 'admin_access' for role
* Fix relation extraction and permissions for `$FOLLOW` fields
* Don't show `0 Items` for child rows, but `--` instead
* Make policy detail work in nested policy creating use case
* Remove unused v-icon override
* Move system collections to separate visual table
* Navigate before refresh
Prevents a flash of the previous value to be visible in the table
* Move composable to separate file
---------
Co-authored-by: Daniel Biegler <DanielBiegler@users.noreply.github.com>
Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
* Optimize types
* Clone query deep
* Optimize type order
* Throw error on invalid role id
* Rename run.js -> run-ast.js
* Re-add filesizes to telemetry report collection that got lost in the merge
* Make `systemCollections` reactive
* Use one column per action to avoid unwanted shifting if some actions are not allowed at all
* Render system and custom together
* Add divider between regular and system permissions if both have elements
* Add AccessService and PoliciesService to `getService`
* Move policy global flags fetching to util
* Move collection access fetching into util
* Remove permissions for `directus_access`, `directus_permissions` and `directus_policies` from schema permissions
* use formatted-value display for name & description in roles & policies
* Rename `process.ts` to `process-ast.ts`
* Fix process-ast import after renaming
* Perform user integrity check on item deletion
* Fix first admin creation on bootstrap
* Revert "Fix first admin creation on bootstrap"
This reverts commit
|
||
|
Pascal Jufer
|
4fcc053d2a |
Move @directus/format-title into the monorepo (#21847)
|
||
|
Brainslug
|
2c4883ae42 |
Filter system collections based on the system property (#21197)
Co-authored-by: Jan Arends <jan.arends@mailbox.org> Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch> |
||
|
Marcel
|
0cee4c0805 |
Add memory package in the list of package names (#21155)
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch> |
||
|
Pascal Jufer
|
c9292fdd13 | Various small codebase clean-ups (#20977) | ||
|
Bevis Halsey-Perry
|
0c54f5a9ef |
Introduce SnippetToggler and New SDK Reference (#19110)
* items semi complete
* updated items page to use snippet toggler and migrated endpoint docs to use it
* updated files page to use snippet toggler and migrated REST and GraphQL endpoint docs to it
* updated activity page to use snippet toggler and migrated REST and GraphQL endpoint doc to it
* updated collections page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* updated dashboards page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated extensions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated fields page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated flows page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated folders page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated notifications page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated operations page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated panels page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated permissions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated presets page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated relations page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated revisions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated roles page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Made headlines consistant with the rest of the doc pages
* Updated server page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated settings page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated shares page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated translations page to use snippet togglers and migrated REST endpoint docs to them
* Updated users page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated utilities page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated webhooks page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated authentication page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated Global Parameters page to use snippet togglers where there are adjacent REST and GraphQL Examples
* Added SDK code snippets to items page and made generic variables consistant
* Added SDK code snippets to files page and made generic variables consistant
* Few lang changes for files page
* Added SDK code snippets to activity page and made generic variables consistant
* Added SDK code snippets to collections page and made generic variables consistant
* Added SDK code snippets to dashboards page and made generic variables consistant
* removed query word from query parameter objects
* Added SDK code snippets to fields page and made generic variables consistant
* SnippetToggler border
* Used dynamic border color for snippettoggler heading
* Spacing top and bottom of snippet toggler in docs
* Removed extra HRs
* Remove manual TOC in query reference
* Small code styling change in items page
* Updated users page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* dashboards fixed up property names
* Small copy update on extensions page
* Updated keys in delete mult notifications REST
* Updated keys in operations
* Update keys in panel delete many
* Update keys in permissions
* Added quotes around generic example ID strings
* Added code formatting to final example in share public info
* Format files
* Refined sidebar
* Insert newline before ending template tags
* Fixed extra closing tags, causing an error, un users ref
* Text Formatting Users
* Put GQL related notes inside toggler
* Added SDK code snippets to flows page and made generic variables consistant
* Added SDK code snippets to folder page and made generic variables consistant
* fixing whitepsace for flows and folders page
* Consistent newlines in SnippetToggler usages
* Run prettier
* Fix 'alwaysDark' definition
* Home page snippet toggler style fixes
* Fix snippet toggler lang hover color in light mode
* Introduce different code theme for light mode
* Added SDK code snippets to notifications page and made generic variables consistant
* Switch to 'material-theme-lighter'
* Format file
* Fix tip
* Fix tip in sdk ref
* Consistent spacing for custom containers
* Added SDK code snippets to operations page and made generic variables consistant
* Lint & format code blocks
* Lint & format operations
* Added SDK code snippets to panels page and made generic variables consistant
* Added SDK code snippets to permissions page and made generic variables consistant
* Added SDK code snippets to presets page and made generic variables consistant
* Added SDK code snippets to relations page and made generic variables consistant
* Added SDK code snippets to revisions page and made generic variables consistant
* Added SDK code snippets to roles page and made generic variables consistant
* Added SDK code snippets to server page and made generic variables consistant
* Added SDK code snippets to settings page and made generic variables consistant
* app_url -> directus_project_url
* Omitted auth details in delete multiple files
* Added quotes to values in roles
* Upload a file snippets
* Pluralization for upload/import files
* More files functions typos
* Added SDK code snippets to shares page (still missing createShare(s) as endpoint not functioning currently) and made generic variables consistant
* Added SDK code snippets to translations page (missing delete endponts because not working) and made generic variables consistant
* Added SDK code snippets to users page and made generic variables consistant
* Added SDK code snippets to webhooks page and made generic variables consistant
* Added SDK code snippets to utilites page (except cleaning cache, will be tested and added in later commit) and made generic variables consistant
* Added SDK code snippets to auth page (not login, refresh, and logout though due to errors)
* Added SDK code snippets for utilsExport and clearCache
* added github username be7DOTis to contributors
* Omit auth commands in updateComment
* utilsImport
* rename app_url generic value
* changed instances of updated*operation* to update*Operation*
* missed some 'updated' changse
* Added SDK Snippets to Query Parameters page
* Add section on file security
* added create(s)Shares SDK snippet to shares page
* added console.log to create snippets
* Added delete(s)Webhook SDK snippet to webhooks page
* Added SDK snippets to extensions page
* Added create/updateSingleton section to items page
* Links in files security
* Added SDK Snippets to Schema page
* Added GQL Generic examples to snippet togglers and removed snippet toggler from Login Using SSO Providers
* Added create(s)Presets SDK Snippets to presets page
* replaced fields query in generics snippets for a more generic
* replaced fields query in generics snippets for a more generic
* Use storage value only if valid choice
* Sync snippet togglers across page
* Update docs/reference/system/activity.md
* Update docs/reference/system/activity.md
* Update docs/reference/system/extensions.md
* Update docs/reference/system/revisions.md
* Update docs/reference/system/settings.md
* Update docs/reference/system/revisions.md
* Update docs/reference/system/settings.md
* Update docs/reference/system/activity.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/schema.md
* Update docs/reference/system/server.md
* Update docs/reference/system/shares.md
* Replace all directus_project_url placeholders
* Revert "Sync snippet togglers across page"
This reverts commit
|
||
|
Brainslug
|
d71b0e94ee |
SDK Revamp (#18987)
* Setup build chain
* Initial structure
* Typing, exports, fix build
* Reorganize
* prutsen met output types
* Thursday fun times
* failed experiments in feature composition
* got feature flags on the client
* using interfaces instead of literals
* messed with decorators
* split up decorators
* added fetch and ws types
* reintroduced the global.d.ts we'll figure that out later
* reworked composables
* some changes
* experimenting with commands
* got the read item command working again with types
* trying authentication
* basic gql implementation
* Super basic websocket implementation
* renamed websocket composable and removed obsolete code
* Typing relational fields
Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
* fixed recursive type
* SDK revamp revamp (#18916)
* Split up files
* Simplify some more (too much?)
* Oh boy we figured out object extending
* OK JK now we're there
* OK getting somewhere real now
* Start structuring type helpers
* Types werken zowaar!
* Remove unneeded "T"'s for readability
* Added support for array relational types
* split up query nesting logic
* make relational fields optional to support multiple relations
* improved readability
* updated REST
* Move URL to top level
* Remove T
* recursively join fields in params
* cleaning up
* updated graphql implementation
* removing old unused code
---------
Co-authored-by: Brainslug <tim@brainslug.nl>
* Reduce global reuse of rest
* Start messing with output types
* Return it from the rest command
* first level schema output filtering
* It works!! but will need some docs for context
* Added some comments
* removed export keyword from types that do not need to be exported
* cleaned up debug script
* graphql update
* Added dom for WebSocket and Fetch typings
* initial readme setup
* moved some types
* removed accidental commit
* Refactor `useDirectus` and improve token handling (#18966)
* Add comment and reduce code of useDirectus
* Add fabian-hiller to contributors.yml
* Change token handling of useDirectus client
---------
Co-authored-by: Brainslug <br41nslug@users.noreply.github.com>
* Change ClientConfig type back to interface (#18968)
* initial realtime feature
* started on some ws commands and implemented message receiving callback
* disabled rest config for now
* setup auth extension boilerplate
* Added some websocket examples to the readme
* docs: add getting started guide
* docs: add link to previous sdk
* docs: updates
* implemented readItem
* updated readItems
* Added delete commands
* docs: updates to snippets and phrasing
* updated lockfile
* Update dictionary
* docs: removed repeated typescript snippet
* Enrich package.json for SDK
* docs: update snippet
* Fix casing of readme
* added create items commands
* fixed read items output
* removed obsolete types
* added update commands
* updated tsup
* removed unused dependencies
* implemented basic memory storage fallback
* implemented the login function for auth
* implemented refresh and logout auth functions
* docs: update guide
* updated auth refresh logic
* oops, have to actually store the expires at value
* fixed authentication timeout
* added autoRefresh config option
* updated readme
* updated getting started
* docs: updates to guide
* added beta version nr
* removed debug scripts
* added docblocks to the composables
* Added some docblocks
* Added BETA warning to readme
* Added extra type extends object checks
* added a bunch of index files
* updated tsup build entrypoints and exports
* updated import paths
* updated code examples
* docs: removed unnecessary phrases
* Unignore SDK changesets
* Revert "docs: removed unnecessary phrases"
This reverts commit
|
||
|
Zeyar Paing
|
d6e0e35970 |
Typo fix for codebase overview docs (#19167)
* Typo fix for codebase overview docs * Update contributors.yml |
||
|
Rijk van Zanten
|
1005738267 | Tweak last quirks in hooks error example (#19122) | ||
|
Kevin Lewis
|
67c008df37 |
Fixes the many broken docs redirects (#19026)
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch> |
||
|
Connor
|
92621429ee |
Linting and Formatting Upgrade (#18892)
* add docs to eslint
* update prettier ignore
* fix vitepress linting
* eslint ignore fixes
* prettier run
* update prettier ignore
* fix formatting
* enable linting of markdown files
* revert format command change
* fix irregular whitespace
* update dictionary
* (Changelog) Create four-boxes-shake.md
* Rework ESLint / Prettier setup
- Disable js/ts/vue files for Prettier to ensure linting/formatting is
only happening via ESLint
- Rework formatting of code blocks in md files
- Disable formatting of code blocks in md files under '/docs' by Prettier
- Instead use "eslint-plugin-markdown" to format & __lint__ js*/ts*/vue such code blocks
- Replace unmaintained "eslint-plugin-md" plugin by official "eslint-plugin-markdown" plugin
- I'll check whether we can use this to format other code blocks
(json, html, ...) as well
- Restructure, clean-up and apply some fixes to the ESLint config
(Note: Not ready for flat config yet since not supported by
vscode-eslint)
- Enable cache for ESLint / Prettier in scripts
- Clean-up ignore file
- Explicit folder declaration (.../)
- Don't ignore all 'extensions' folders in ESLint (only
'/api/extensions/')
- Enable formatting in '/.github' folder
* Fix all formatting issues with Prettier
* Update md files under /docs/.typedocs
* Fix lint issues in vue/js files
* ESLint / Prettier config revision v2
Enable Prettier for md code blocks, but only as warnings since it can
get into the way with Vitepress md extensions like '[!code ...]'
comments
* Remove prettier-ignore comments
* Make spellchecker happy
* Remove changeset
* Revert lint setup for code blocks
There are many cases in the docs where linting / formatting of code
blocks doesn't make
sense:
- Code block is only an excerpt - linter fails
- Code block contains special comments (e.g. markdown extensions) which
needs to remain at the same place - formatting would break it
- ...
* Apply lint issues / formatting from temp lint setup
* Run formatter
* Fix merge failure
* Simplify & modernize ESLint / Prettier setup
No longer run Prettier via ESLint. Nowadays, this is the recommended
setup. There's no real need to run it this way, it's just an additional
layer.
Add VS Code settings to make the work with the new setup easier.
* Remove unused eslint disable directives
* Make editorconfig more useful
* Fix formatting issues reported by editorconfig
* Format files with Prettier
* Enable formatting of source translations file
* Format source translations file
* Remove unnecessary console error
* Remove unnecessary line
* Only ignore md files under .changeset
* Add CI reporter for Prettier
* Fail job on wrongly formatted files
* Fix format
* Test Prettier action on changed/added file
* Use simple CI format check for now & no cache
* Revert "Test Prettier action on changed/added file"
This reverts commit
|
||
|
Connor
|
94bfecf72e |
Fix Docs Broken Links and add License to @directus/stores (#18988)
* add license to stores package * fix broken links * disable edit link on generated documentation * Create heavy-papayas-buy.md |
||
|
Connor
|
5e1f02dba1 |
Add TypeDocs to Docs (#18867)
* Create package * TypeDoc Init Config * Start Config * Configure Packages * Generation * Add Plugins * Vitepress Generation * More Generation * Fix Lock File * Fix Connections * Build Step * Deployment Testing * Fix Sidebar * Fix Lock File * Deployment Fix * Change Sidebar * Final POC/MVP Updates * fix commands * fix dev deps * fix netlify functions * CHANGELOG: Create warm-spiders-double.md * Fix typing * Remove double title --------- Co-authored-by: rijkvanzanten <rijkvanzanten@me.com> |
||
|
Connor
|
f667fe7658 |
Contributor Docs Improvements Round 2 (#18667)
* add delete by query information and examples * add that changelogs should be past tense * add examples of unit and blackbox tests * add information on where upload/extension folder should go locally * add new packages and remove redundant column * fix spelling * Create hot-pillows-tan.md * Fix tip box and links * Update docs/contributing/codebase-overview.md Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch> * Update docs/contributing/running-locally.md Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch> --------- Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch> |
||
|
Connor
|
b67c4cd2e2 |
Contributor Docs Improvements Round 1 (#18545)
* Move Debug Docs from Wiki to Docs * Add Copyright License Agreement to Docs * Start Reformat0 of Codebase Overview * Add Package Documentation to Codebase Overview * Add Link to Blackbox Folder * Add Changesets to Pull Request Process * Add Component Library Tips * Fix Spelling * Fix dictionary * Create thick-glasses-bake.md --------- Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com> |
||
|
Rijk van Zanten
|
c723085902 |
Move docs to monorepo (#18052)
* Move docs to monorepo * Tweaks |
||
|
Rijk van Zanten
|
288e7d62b9 |
Move docs folder to dedicated repo (#14192)
* Move docs to https://github.com/directus/docs * Update included docs |
||
|
Azri Kahar
|
19cbe896b4 | docs updates on file library, content sidebar etc (#10334) | ||
|
Azri Kahar
|
8f7a3dc9cd | update vue 2 to vue 3 in codebase overview (#7648) | ||
|
rijkvanzanten
|
22535bf566 |
Resolve TKs/@TODOs in docs
Fixes #3287 |
||
|
rijkvanzanten
|
fb5c9068bc | List updated min requirement | ||
|
Rijk van Zanten
|
817ccf3620 |
Overhaul docs (#3951)
* Add Quickstart Guide * Update installation * Remove unused files * Update support/backing * Tweaks in concepts * Setup file structure for API reference 2.0 * Setup page layout for reference * Add clean-urls plugin * getting started updates * Finish authentication rest * getting started updates * Render stylus in 2 spaces * Various * Various * Finish activity docs * Add collections reference * Add extension reference * concepts updates * Fields/tweaks * Add files doc * Add revisions * concepts docs * More api reference * Finish rest api reference (finally) * initial concepts * More things * Add assets api ref * Move sections from file to assets * Add environment variables * contributing docs * Add field transforms page * Left align table headers * concept links * Add API config * Fix mobile nav * Add migrating a project * doc link fixes Co-authored-by: Ben Haynes <ben@rngr.org> |