feat: add layer dependency filtering options #207
Conversation
|
I can't say I understand this test failure. @bitpshr have you seen that |
There was a problem hiding this comment.
Looks good so far. The SDK throws a MultiError instance that contains references to the underlying API and CLI error, if either exist. If you log that error you should see what's actually going wrong. After a quick glance, it looks like the tests are failing because the test mocks need to be updated in Layers.test.js. Since you added new HTTP parameters, those mocked URLs should be updated to include them. Also, can you please update the TypeScript definition file and the documentation in abstract-api.md to line up with the new filter options?
| @@ -851,7 +851,7 @@ A layer is a container for designs. In Sketch a layer usually represents an artb | |||
|
|
|||
| ![CLI][cli-icon] ![API][api-icon] | |||
|
|
|||
| `layers.list(FileDescriptor | PageDescriptor, ListOptions): Promise<Layer[]>` | |||
| `layers.list(FileDescriptor | PageDescriptor, LayersListOptions): Promise<Layer[]>` | |||
There was a problem hiding this comment.
There's no other documentation for what this type is, should I add it somewhere?
There was a problem hiding this comment.
Our documentation is a mess, this will hopefully be fixed soon. For now, feel free to define this where ListOptions is defined towards the end of this document.
docs/abstract-api.md
Outdated
| offset: 0 | ||
| offset: 0, | ||
| excludeLibraryDependencies: false, | ||
| onlyLibraryDependencies: false |
There was a problem hiding this comment.
I added these here just to say that they exist but they're probably very out of place.
There was a problem hiding this comment.
This is fine for now. When we generate API documentation (planned), this will be shown in the right spot.
|
Did you consider using a single
|
|
The same was suggested in the backend PR https://github.com/goabstract/projects/pull/3894#discussion_r367148849 I'll update |
|
Oh, lol – that was later down my list of PR's to get to 😄 |
|
updated the option to |
Depends on https://github.com/goabstract/projects/pull/3894, posting the same explanation here for visibility
This adds two new filtering options for layers:
excludeLibraryDependencies- this will make it so that symbols from external libraries are not included in the list of layers. These are the items that we show as "dependencies" in the file list and aren't shown by default unless you click on them.onlyLibraryDependencies- the opposite ofexcludeLibraryDependencies. You can choose this option if you need to load the library dependencies separately.These options should help our pagination of layers be a little more intuitive so that we don't load pages of data that aren't even shown in the screen you're looking at.