{"_id":"swiftspec","_rev":"36-0f847c006d13411e487ce3e254385f62","name":"swiftspec","dist-tags":{"latest":"1.0.20"},"versions":{"1.0.16":{"name":"swiftspec","version":"1.0.16","keywords":["api","documentation","nodejs","javascript","swiftspec","docs"],"author":{"name":"José Reginaldo","email":"jrsnpe@gmail.com"},"license":"MIT","_id":"swiftspec@1.0.16","maintainers":[{"name":"jrsnpe","email":"jrsnpe@gmail.com"}],"homepage":"https://github.com/jrsnpe/swiftspec#readme","bugs":{"url":"https://github.com/jrsnpe/swiftspec/issues"},"bin":{"swiftspec":"bin/swiftspec.js"},"dist":{"shasum":"1afc92d46cf2aa861e1e972d643c921e630a0769","tarball":"https://registry.npmjs.org/swiftspec/-/swiftspec-1.0.16.tgz","fileCount":14,"integrity":"sha512-wi2Ro1TUphnwq+n2vUfxbQD6t5UDN+5pzpjqc25BjvBzkEiBsOL5Op31DPDCRXGoXckwLU3S91HsE/E211/2rA==","signatures":[{"sig":"MEUCID1M1bcd138XGYKewIIWEspTM83dQT8f3VvF6OIvpe70AiEAi9UYI7Y6GpZH8ZD+e9mkSP0s1KVYdZOyMZbP/LuxvDI=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":197191},"main":"lib/index.js","engines":{"npm":">=6.0.0","node":">=14.0.0"},"gitHead":"77012c65ada39e540a30ec6b85971054c2624784","scripts":{"lint":"eslint .","test":"echo \"No tests specified\" && exit 0","start":"node bin/swiftspec.js","format":"prettier --write .","configure":"node scripts/postinstall.js","postinstall":"node scripts/postinstall.js","unconfigure":"node scripts/unconfigure.js","prepublishOnly":"npm run lint"},"_npmUser":{"name":"jrsnpe","email":"jrsnpe@gmail.com"},"repository":{"url":"git+https://github.com/jrsnpe/swiftspec.git","type":"git"},"_npmVersion":"11.2.0","description":"SwiftSpec - Ferramenta de documentação de API rápida e impressionante para Node.js e JavaScript","directories":{},"_nodeVersion":"22.11.0","dependencies":{"cors":"^2.8.5","acorn":"^8.5.0","express":"^4.17.1","acorn-walk":"^8.3.4"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.23.0","prettier":"^2.4.1"},"_npmOperationalInternal":{"tmp":"tmp/swiftspec_1.0.16_1742687942362_0.9285318404442233","host":"s3://npm-registry-packages-npm-production"}},"1.0.17":{"name":"swiftspec","version":"1.0.17","keywords":["api","documentation","nodejs","javascript","swiftspec","docs"],"author":{"name":"José Reginaldo","email":"jrsnpe@gmail.com"},"license":"MIT","_id":"swiftspec@1.0.17","maintainers":[{"name":"jrsnpe","email":"jrsnpe@gmail.com"}],"homepage":"https://github.com/jrsnpe/swiftspec#readme","bugs":{"url":"https://github.com/jrsnpe/swiftspec/issues"},"bin":{"swiftspec":"bin/swiftspec.js"},"dist":{"shasum":"ff70d73c65ea3ce2750ae6a66d01443b1cc45262","tarball":"https://registry.npmjs.org/swiftspec/-/swiftspec-1.0.17.tgz","fileCount":14,"integrity":"sha512-vzV1ay1yMnYUaGqzCUNsqsLckTTOFeWeDn97J5Bsuxg0w8vgo4CatDWuHtyZb9pDIRIjpgtkKFrhk3ZfPqkcrw==","signatures":[{"sig":"MEUCIGkfsgC9H8lqM8JSznbO4QGjY9T45OhuPHMMUV4b4TFUAiEAnz5pirVQ02WXwv0OufSo81AGn0XZU3mTpIztBRyPFpU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":197886},"main":"lib/index.js","engines":{"npm":">=6.0.0","node":">=14.0.0"},"gitHead":"61d5f71c94a1b2a7eccede4a15875236316e7033","scripts":{"lint":"eslint .","test":"echo \"No tests specified\" && exit 0","start":"node bin/swiftspec.js","format":"prettier --write .","configure":"node scripts/postinstall.js","postinstall":"node scripts/postinstall.js","unconfigure":"node scripts/unconfigure.js","prepublishOnly":"npm run lint"},"_npmUser":{"name":"jrsnpe","email":"jrsnpe@gmail.com"},"repository":{"url":"git+https://github.com/jrsnpe/swiftspec.git","type":"git"},"_npmVersion":"11.2.0","description":"SwiftSpec - Ferramenta de documentação de API rápida e impressionante para Node.js e JavaScript","directories":{},"_nodeVersion":"22.11.0","dependencies":{"cors":"^2.8.5","acorn":"^8.5.0","express":"^4.17.1","acorn-walk":"^8.3.4"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.23.0","prettier":"^2.4.1"},"_npmOperationalInternal":{"tmp":"tmp/swiftspec_1.0.17_1742705410463_0.8921479008728959","host":"s3://npm-registry-packages-npm-production"}},"1.0.20":{"name":"swiftspec","version":"1.0.20","description":"SwiftSpec - Ferramenta de documentação de API rápida e impressionante para Node.js e JavaScript","main":"lib/index.js","bin":{"swiftspec":"bin/swiftspec.js"},"scripts":{"test":"echo \"No tests specified\" && exit 0","start":"node bin/swiftspec.js","lint":"eslint .","format":"prettier --write .","prepublishOnly":"npm run lint","postinstall":"node scripts/postinstall.js","configure":"node scripts/postinstall.js","unconfigure":"node scripts/unconfigure.js"},"keywords":["api","documentation","nodejs","javascript","swiftspec","docs"],"author":{"name":"José Reginaldo","email":"jrsnpe@gmail.com"},"license":"MIT","dependencies":{"acorn":"^8.5.0","acorn-walk":"^8.3.4","cors":"^2.8.5","express":"^4.17.1"},"devDependencies":{"eslint":"^8.23.0","prettier":"^2.4.1"},"repository":{"type":"git","url":"git+https://github.com/jrsnpe/swiftspec.git"},"bugs":{"url":"https://github.com/jrsnpe/swiftspec/issues"},"homepage":"https://github.com/jrsnpe/swiftspec#readme","engines":{"node":">=14.0.0","npm":">=6.0.0"},"_id":"swiftspec@1.0.20","gitHead":"2dc7f72dfc5a32496623cdc6cdaa2f4c469138b0","_nodeVersion":"22.11.0","_npmVersion":"11.2.0","dist":{"integrity":"sha512-GFugsr7NbyrWMMgNAGXkGDWldI1kThtGnXN9QijKtgglwb5dI7ClNdtD6jSOwajLgXOfk4uMzoOgEtl+bjVAOg==","shasum":"c9263345de3f5afecc367fa7e6499101edf806af","tarball":"https://registry.npmjs.org/swiftspec/-/swiftspec-1.0.20.tgz","fileCount":14,"unpackedSize":203675,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCICJLTvBwlfbuIXDKdgWBLBrpeJk32wLx050XVSD05FiPAiAejiFGrzqRidCPiy9dQMvuqcK4CStpWj8SakBcEYjwIA=="}]},"_npmUser":{"name":"jrsnpe","email":"jrsnpe@gmail.com"},"directories":{},"maintainers":[{"name":"jrsnpe","email":"jrsnpe@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/swiftspec_1.0.20_1742814241296_0.505886695055922"},"_hasShrinkwrap":false}},"time":{"created":"2025-03-21T20:58:41.565Z","modified":"2025-03-24T11:04:01.690Z","1.0.0":"2025-03-21T20:58:41.827Z","1.0.1":"2025-03-21T21:14:13.877Z","1.0.2":"2025-03-21T21:18:00.747Z","1.0.3":"2025-03-21T21:20:20.528Z","1.0.4":"2025-03-21T21:23:55.236Z","1.0.5":"2025-03-21T21:30:58.013Z","1.0.8":"2025-03-22T13:20:41.215Z","1.0.9":"2025-03-22T14:43:58.845Z","1.0.10":"2025-03-22T17:41:48.903Z","1.0.11":"2025-03-22T17:46:30.787Z","1.0.12":"2025-03-22T18:02:34.773Z","1.0.13":"2025-03-22T18:05:10.949Z","1.0.14":"2025-03-22T18:43:18.961Z","1.0.15":"2025-03-22T18:50:48.913Z","1.0.16":"2025-03-22T23:59:02.590Z","1.0.17":"2025-03-23T04:50:10.708Z","1.0.18":"2025-03-24T11:02:13.972Z","1.0.20":"2025-03-24T11:04:01.476Z"},"bugs":{"url":"https://github.com/jrsnpe/swiftspec/issues"},"author":{"name":"José Reginaldo","email":"jrsnpe@gmail.com"},"license":"MIT","homepage":"https://github.com/jrsnpe/swiftspec#readme","keywords":["api","documentation","nodejs","javascript","swiftspec","docs"],"repository":{"type":"git","url":"git+https://github.com/jrsnpe/swiftspec.git"},"description":"SwiftSpec - Ferramenta de documentação de API rápida e impressionante para Node.js e JavaScript","maintainers":[{"name":"jrsnpe","email":"jrsnpe@gmail.com"}],"readme":"# SwiftSpec\r\n\r\n
\r\n\r\n## Índice\r\n\r\n- [Sobre o Projeto](#sobre-o-projeto)\r\n- [Características](#características)\r\n- [Começando](#começando)\r\n - [Pré-requisitos](#pré-requisitos)\r\n - [Instalação](#instalação-e-utilização)\r\n - [Instalação](#utilização-manual)\r\n - [Versões Obsoletas](#versões-obsoletas)\r\n- [Contribuindo](#contribuindo)\r\n- [Contato](#contato)\r\n\r\n## Sobre o Projeto\r\n\r\nSwiftSpec é uma ferramenta de documentação de API projetada para transformar o processo de criação e manutenção de especificações de API. Com foco na eficiência e clareza, SwiftSpec permite que desenvolvedores e equipes técnicas criem documentação de API de alta qualidade em uma fração do tempo tradicional.\r\n\r\n## Características\r\n\r\n- 🚀 **Geração Rápida**: Crie documentação completa em questão de segundos\r\n- 📚 **Clareza Incomparável**: Transforme códigos complexos em documentação cristalina\r\n- 🎨 **Design Impressionante**: APIs que não só funcionam bem, mas também impressionam visualmente\r\n- 🔄 **Sincronização em Tempo Real**: Atualizações automáticas conforme o código muda\r\n- 🌐 **Suporte Multi-linguagem**: Compatível com várias linguagens e frameworks\r\n- 👥 **Colaboração Integrada**: Facilita o trabalho em equipe na documentação\r\n\r\n## Começando\r\n\r\n### Pré-requisitos\r\n\r\n- Node.js (versão 14.0.0 ou superior)\r\n- npm (normalmente vem com Node.js)\r\n\r\n### Instalação e Utilização\r\n\r\n```bash\r\nnpm install swiftspec\r\n```\r\n\r\nou globalmente:\r\n\r\n```bash\r\nnpm install -g swiftspec\r\n```\r\n\r\nSe a configuração não iniciar automaticamente, você pode executá-la manualmente:\r\n\r\n```bash\r\nnpx swiftspec configure\r\n```\r\n\r\nSe a configuração ficou incorreta, você pode remover e iniciar o processo novamente:\r\n\r\n```bash\r\nnpx swiftspec unconfigure\r\n```\r\n\r\nGerar a documentação do seu projeto:\r\n\r\n```bash\r\nswiftspec generate\r\n```\r\n\r\nIniciar o servidor para visualizar a documentação já existente:\r\n\r\n```bash\r\nswiftspec serve\r\n```\r\n\r\nGerar a documentação e iniciar o servidor em um único comando:\r\n\r\n```bash\r\nswiftspec start\r\n```\r\n\r\n### Utilização Manual\r\n\r\nGerar documentação para um projeto específico:\r\n\r\n```bash\r\nswiftspec generate ./meu-diretorio-origem ./meu-diretorio-saida\r\n```\r\n\r\nIniciar o servidor em uma porta específica:\r\n\r\n```bash\r\nswiftspec serve ./meu-diretorio-saida 8080\r\n```\r\n\r\nGerar e servir documentação em uma porta específica:\r\n\r\n```bash\r\nswiftspec start ./meu-diretorio-saida 8080\r\n```\r\n\r\nPara exclusão manual do arquivo de configuração:\r\n\r\n- Localize e exclua o arquivo `swiftspec.config.json` na raiz do seu projeto.\r\n- Após remover a configuração, o SwiftSpec usará as configurações padrão em futuras execuções, ou você pode reconfigurar.\r\n\r\n## Versões Obsoletas\r\n\r\nRecomendamos fortemente que todos os usuários atualizem para a versão mais recente para obter as últimas correções de bugs, melhorias de segurança e novas funcionalidades.\r\n\r\nPara atualizar, execute:\r\n\r\n```bash\r\nnpm install -g swiftspec@latest\r\n```\r\n\r\n## Contribuindo\r\n\r\nSwiftSpec é um projeto de código aberto e nós adoraríamos contar com a sua ajuda para torná-lo ainda melhor! Há várias maneiras de contribuir:\r\n\r\n### Para Desenvolvedores\r\n\r\n1. **Código**: Implemente novas features, corrija bugs ou melhore a estrutura do código.\r\n2. **Documentação**: Ajude a melhorar ou traduzir a documentação.\r\n3. **Testes**: Escreva testes para aumentar a cobertura e garantir a estabilidade.\r\n4. **Revisão**: Revise pull requests de outros contribuidores.\r\n\r\n### Para Não-Desenvolvedores\r\n\r\n1. **Feedback**: Use o SwiftSpec e nos conte sua experiência.\r\n2. **Ideias**: Sugira novas features ou melhorias.\r\n3. **Divulgação**: Compartilhe o SwiftSpec com outros desenvolvedores.\r\n4. **Design**: Contribua com melhorias de UI/UX para a documentação gerada.\r\n\r\nPara começar:\r\n\r\n1. Faça um Fork do projeto\r\n2. Crie sua Feature Branch (`git checkout -b feature/AmazingFeature`)\r\n3. Commit suas mudanças (`git commit -m 'Add some AmazingFeature'`)\r\n4. Push para a Branch (`git push origin feature/AmazingFeature`)\r\n5. Abra um Pull Request\r\n\r\nJunte-se a nós e faça parte desta jornada para transformar a forma como documentamos APIs!\r\n\r\n## Contato\r\n\r\nTemos vários canais para você entrar em contato conosco:\r\n\r\n- **Criador do Projeto**: José Reginaldo\r\n\r\n - GitHub: [@jrsnpe](https://github.com/jrsnpe)\r\n - NPM: [~jrsnpe](https://www.npmjs.com/~jrsnpe)\r\n - Linkedin: [/in/reginaldo](https://www.linkedin.com/in/reginaldo/)\r\n - Instagram: [/reginaldoneto](https://www.instagram.com/reginaldoneto/)\r\n - Email: jrsnpe@gmail.com\r\n\r\n- **Equipe de Desenvolvimento**:\r\n\r\n - Faça Parte e tenha seu nome aqui!\r\n - Email: jrsnpe@gmail.com\r\n\r\n- **Suporte**:\r\n\r\n - Email: jrsnpe@gmail.com\r\n\r\n- **Repositório do Projeto**: [https://github.com/jrsnpe/swiftspec](https://github.com/jrsnpe/swiftspec)\r\n\r\nFique à vontade para nos contatar. Adoraríamos ouvir suas ideias, feedback ou qualquer pergunta que você possa ter!\r\nParticipe das discussões, compartilhe suas experiências e aprenda com outros usuários do SwiftSpec!\r\n\r\n```\r\n\r\n```\r\n","readmeFilename":"README.md"}
![\"SwiftSpec](\"./assets/swiftspec-logo.png\"){kind=logo}
\r\n![\"npm](\"https://img.shields.io/npm/v/swiftspec.svg\")
\r\n ![\"License:](\"https://img.shields.io/badge/License-MIT-yellow.svg\"){kind=icon}
\r\n ![\"Node.js](\"https://img.shields.io/node/v/swiftspec\")
![\"Downloads\"](\"https://img.shields.io/npm/dm/swiftspec\")
![\"JavaScript\"](\"https://img.shields.io/badge/JavaScript-F7DF1E?style=flat&logo=javascript&logoColor=black\"){kind=icon}