Error when running `yarn generate-adaptors`

Ouverte
  • Quelque chose ne va pas ?
#682 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
45/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
javascript
Domaine
documentation

Piste de recherche

Commencez par exécuter yarn generate-adaptors et examinez sidebars-adaptors.js autour des lignes 89-91. Déterminez quel enregistrement de vue d’ensemble produit un id vide et si cela provient des données source ou de la génération de la barre latérale. C’est terminé lorsque la cause sous-jacente est corrigée et que la commande s’exécute sans l’erreur de validation de la barre latérale de Docusaurus.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Description
I was getting the error below 👇🏽, when running yarn generate-adaptors.

ERROR] Sidebars file at "/Users/openfn/Workspace/docs/sidebars-adaptors.js" failed to be loaded.
[ERROR] Loading of version failed for version current

[ERROR] Error [ValidationError]: {
  "type": "doc",
  "label": "",
  "translatable": true,
  "id" [1]: ""
}

[1] "id" is not allowed to be empty
    at exports.process (/Users/openfn/Workspace/docs/node_modules/joi/lib/errors.js:193:16)
    at internals.entry (/Users/openfn/Workspace/docs/node_modules/joi/lib/validator.js:250:26)
    at exports.entry (/Users/openfn/Workspace/docs/node_modules/joi/lib/validator.js:27:30)
    at internals.Base.validate (/Users/openfn/Workspace/docs/node_modules/joi/lib/base.js:548:26)
    at internals.assert (/Users/openfn/Workspace/docs/node_modules/joi/lib/index.js:225:27)
    at Object.assert (/Users/openfn/Workspace/docs/node_modules/joi/lib/index.js:102:19)
    at validateSidebarItem (/Users/openfn/Workspace/docs/node_modules/@docusaurus/plugin-content-docs/lib/sidebars/validation.js:124:28)
    at Array.forEach (<anonymous>)
    at /Users/openfn/Workspace/docs/node_modules/@docusaurus/plugin-content-docs/lib/sidebars/validation.js:131:17
    at Array.forEach (<anonymous>) {
  _original: { type: 'doc', id: '', label: '', translatable: true },
  details: [
    {
      message: '"id" is not allowed to be empty',
      path: [ 'id' ],
      type: 'string.empty',
      context: { label: 'id', value: '', key: 'id' }
    }
  ]
}

I traced the root cause of the error to https://github.com/OpenFn/docs/blob/main/sidebars-adaptors.js#L89-L91

  const extras = overviews
    .filter(id => !adaptors.map(a => `${a.name}`).includes(id))
    .map(id => ({ type: 'doc', id, label: id }));

which was happening because id was '' for one of the record. I fixed it by checking if id && !adaptors.map(a => ${a.name}).includes(id) But i am not sure if this is the proper fix because we need to know why the id value is ''

Langage dominant
JavaScript
Étoiles
25
Forks
22
Merge moyen
23 h 27 min
PR mergées (30 j)
46

Préparer son environnement

  • Aucun Dockerfile ni fichier Docker Compose
  • Propose un modèle de pull request
  • Aucun guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de OpenFn/docs

Toutes les issues de OpenFn/docs

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.