writeme-project / writeme

Cross-platform README.md generator
GNU General Public License v3.0
14 stars 0 forks source link

Detect technologies of the project #6

Closed BabelDev0 closed 1 year ago

BabelDev0 commented 1 year ago

Per riconoscere quali tecnologie sono state usate dal progetto, in modo da creare shields, elenchi di dependencies e altro, ho creato un file Json per mantenere traccia dei file di config e dei nomi delle dependency usati dalle tecnologie più comuni per ora (eslint, prettier). l'idea è quella di cercare se questi config o dependency sono presenti nel progetto e se si creare i relativi shield e info nel README.md

ilcors-dev commented 1 year ago

ti dico come sto strutturando la parte del merge che magari può essere utile per questa parte: pensavo di creare una sorta di parser che a prescindere dal file di config sputi fuori una unica struct unificata con le info rilevanti utili per generare il readme (vedi qua) se in questa struct ci infiliamo la parte delle dependencies poi la si può dare in pasto a questa parte che stai facendo tu @BabelDev0

BabelDev0 commented 1 year ago

Si, direi che potremmo agire con un pezzo di codice per trovare i file config che ci sono fare parsing con i tuoi decorator e controllarne le dependency.

In questo modo riconosciamo le tecnologie usate attraverso i file di config presenti e prendiamo le informazioni del progetto da questi ultimi

ilcors-dev commented 1 year ago

ok fatto vedi come ti sembra

ilcors-dev commented 1 year ago

lista delle tecnologie riconosciute e cosa farne (wip)

tech da dove la peschiamo cosa ci facciamo
eslint dependencies, config files shield
prettier dependencies, config files shield
laravel dependencies shield
yarn config files (yarn-lock.json) usage
npm config files (package-lock.json) usage
pnpm config files (pnpm-lock.yml) usage
vite config files shield, usage
tailwind config files, dependencies shield
bootstrap config files, dependencies shield
inertia dependencies shield
typescript config files shield
vue dependencies shield
react dependencies shield
angular dependencies shield
svelte dependencies shield
solid dependencies shield
cypress config files, dependencies shield, tests
pest dependencies shield, tests
phpunit config files, dependencies shield, tests
mochajs config files, dependencies shield, tests
jest config files, dependencies shield, tests
laravel dusk dependencies shield, tests
tauri dependencies shield, usage
nextjs dependencies shield
nuxtjs dependencies shield
express dependencies shield
remixjs dependencies shield
docker config files shield, usage

max 5 shield per ora stupido, i primi 5. dopo magari per categoria: linter - framework - package manager - ecc