- Issue created by @brianperry
- πΊπΈUnited States brianperry
Slowly chipping away at some of this on the scaffold branch on this fork. Helps me to have a little code to play with as I flesh out some of the related issues...
- πΊπΈUnited States brianperry
@mitchellmarkoff is going to take a look at adding Eslint and Typedoc as outlined here: https://www.drupal.org/project/api_client/issues/3374157 β
- First commit to issue fork.
- πΊπΈUnited States brianperry
@mitchellmarkoff took a look at the `code-standards` branch. What is there looks good so far. I think what remains is mostly scripts to make use of it. Now that the config and dependencies exist, there should be an npm script that lints the codebase.
And not sure if this branch is actually intended to cover tsdoc yet, but I think it would be helpful to have something that can generate docs based on the tsdoc comments, even if we're only using it as a development tool. Typedoc could be a simple option for this: https://typedoc.org/
Also, do we need to add https://tsdoc.org/pages/packages/eslint-plugin-tsdoc/ to lint our tsdoc comments, or does `eslint-config-airbnb-typescript` take care of that?
So I think the remaining tasks are:
* Add a lint script.
* Add Typedoc
* Add an example tsdoc comment for an existing function so Typedoc can generate something.
* Evaluate if we need eslint-plugin-tsdoc - πΊπΈUnited States brianperry
Added a json-api-client example and dev script on the `scaffold` branch.
- πΊπΈUnited States brianperry
Added a husky pre-push hook. I think there might be a little tweaking to do on the prettier config. The git hook tends to complain about minor formatting issues that seem to be created by format on save during editing. Easy to get around manually, but something we should be able to iron out.
- @brianperry opened merge request.
- @brianperry opened merge request.
- Status changed to Fixed
over 1 year ago 1:16am 15 August 2023 - πΊπΈUnited States brianperry
I'm sure we'll continue to make adjustments as we go along, but the initial work here has been merged to our main and canary branches!
Automatically closed - issue fixed for 2 weeks with no activity.