npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@moblybr/tools-doc-validator

v1.1.0

Published

Useful to parse and validate doc configuration in a pipeline (CI/CD) or CLI

Downloads

5

Readme

@mobly/tools/doc-validator

Este pacote valida uma configuração obrigatória nos serviços Mobly, referentes à documentação e descrição dos serviços.

Requerimentos:

  • Variáveis de ambiente no Bitbucket:
    • CLIENT_ID
    • CLIENT_SECRET

Estas variáveis servirão para efetuar commit e push no repositório que centraliza as documentações, explicado mais abaixo em "Configuração do Pipeline".

  • Arquivo de configuração (vide "Configuração do Pacote")

Uso:

npx @mobly/tools-doc-validator

Argumentos da CLI:

-c, --config [Required, default: null]

Path do arquivo de configuração

Configuração do Pacote:

Para efetuar a configuração do pacote, é obrigatório ter no repositório um arquivo .json ou .yml conforme os exemplos abaixo:

Note que alguns campos básicos são obrigatórios e o opcionais são os presentes em additionalInfo. Todos os campos nos exemplos são suportados e campos adicionais serão ignorados.

collectCoverage:

O uso do campo collectCoverage em projectDetails depende de duas configurações:

  • Adicionar o argumento --collectCoverage na comando de teste do jest;

  • Caso não tenha em sua configuração do jest no arquivo package.json, adicione:

      "coverageReporters": [
        "json-summary"
      ]

Com isso será gerada uma pasta coverage na raiz do projeto e dentro dela deverá estar o arquivo coverage-summary.json.

Configuração do Pipeline:

Este pacote é utilizado somente em um ambiente de CI/CD do bitbucket atualmente e é necessário efetuar algumas configurações no arquivo bitbucket-pipelines.yml para rodar o upload da documentação.

Adicione esse passo no pipeline desejado: (não altere nada!)

      - step:   
          name: Validate documentation
          caches:
            - node
          script:
            - npx @moblybr/tools-doc-validator -c="./documentation-config.json"
            - apt-get update && apt-get install -y curl jq
            - >
              export access_token=$(curl -s -X POST -u "${CLIENT_ID}:${CLIENT_SECRET}" \
                https://bitbucket.org/site/oauth2/access_token \
                -d grant_type=client_credentials -d scopes="repository"| jq --raw-output '.access_token')
            - mkdir doc-creator && cd doc-creator
            - git remote set-url origin "https://x-token-auth:${access_token}@bitbucket.org/mobly/mobly-tools-doc-creator"
            - git clone https://x-token-auth:${access_token}@bitbucket.org/mobly/mobly-tools-doc-creator
            - cd ./mobly-tools-doc-creator/content
            - mkdir -p product-service && cd product-service
            - cp ../../../../_index.md .
            - git add .
            - git config --global user.email "[email protected]"
            - git config --global user.name "Mobly Bot"
            - git commit -m "Added documentation from Product Service"
            - git push
          condition:
            changesets:
                includePaths:
                  - "documentation-config.json"