groups.order now supports * wildcard, so you can put groups at the end

[ProjectZero4]

…to determine where in the ordering all unspecified groups will be placed.

Opening this one as a Draft so we can talk about implementation/config @shalvah. Hopefully this is a feaure Scribe can support.

This PR is adding a feature which allows you to bury endpoints at the bottom of the list for example older versions that you don't want consumers going to first.

This is done with the following config:

return [
// ...top of config
        'order' => [
            'First Group',
            'Second Group',
            '*',
            'Last Group',
        ],
// ...rest of config
];

This will generate the groups like the screenshot below:

[shalvah]

Makes sense (and no new config items😆); I like.👍

[shalvah]

Question: did you find it difficult to contribute (is knowing where to look, what goes where, how to add tests, etc)?

[ProjectZero4]

Just been playing around with the current implementation, it loses the natural order sort so I'll have a re think on this

[ProjectZero4]

Question: did you find it difficult to contribute (is knowing where to look, what goes where, how to add tests, etc)?

There's always been tests related to what I've changed to it's easy to find them. In terms of the code, my ide gets me around fast so I don't really have to spend time looking for things that much

[ProjectZero4]

This new implementation retains the natural sorting functionality for the wildcard groups

[shalvah]

Btw, does it also work for subgroups?

            '10. Group 10',
            '13. Group 13' => [
                'SG B' => [
                    'POST /api/action13d',
                    '*',
                    'GET /api/action13a',
                ],
                '*',
                'SG A',
                'PUT /api/action13c',
            ],
        ]]);

[shalvah]

Could you send a PR to the docs repo as well? https://github.com/knuckleswtf/scribe-docs

I think the places you need to update are https://scribe.knuckles.wtf/laravel/reference/config#order and https://scribe.knuckles.wtf/laravel/tasks/sorting-and-inheritance#sorting-endpoints-and-groups. Can probably just edit them from the GitHub UI.

[ProjectZero4]

Btw, does it also work for subgroups?

            '10. Group 10',
            '13. Group 13' => [
                'SG B' => [
                    'POST /api/action13d',
                    '*',
                    'GET /api/action13a',
                ],
                '*',
                'SG A',
                'PUT /api/action13c',
            ],
        ]]);

Not currently, it seems the sub group sorting is done differently to the top level groups.

We could look at adding support for that later?

[ProjectZero4]

I've created knuckleswtf/scribe-docs#25 for the documentation.

I'm having trouble getting docusaurus to start however. So I have not been able to confirm what this looks like.

Below is the error I get running yarn start

yarn run v1.22.19
$ cross-env NODE_OPTIONS=docusaurus start
events.js:377
      throw er; // Unhandled 'error' event
      ^

Error: spawn start ENOENT
    at Process.ChildProcess._handle.onexit (internal/child_process.js:277:19)
    at onErrorNT (internal/child_process.js:472:16)
    at processTicksAndRejections (internal/process/task_queues.js:82:21)
Emitted 'error' event on ChildProcess instance at:
    at Process.ChildProcess._handle.onexit (internal/child_process.js:283:12)
    at onErrorNT (internal/child_process.js:472:16)
    at processTicksAndRejections (internal/process/task_queues.js:82:21) {
  errno: -2,
  code: 'ENOENT',
  syscall: 'spawn start',
  path: 'start',
  spawnargs: []
}
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

[shalvah]

No worries, that's JavaScript for you. Top-level support is fine for now.