joewiz / airtable.xq Goto Github PK

a master issue for observations about generator-exist

• the tests supplied with generator-exist seem to conflate package title and description in the mocha tests at https://github.com/joewiz/airtable.xq/blob/master/test/mocha/app_spec.js#L68-L102:

  • expath-pkg.xml's title = the name of the package
  • repo.xml's description = the description of the package
  • build.xml's description = the description of the build file, but fine if this is expected to be the description of the package
  • package.json has name & description -> so use the former to check expath-pkg.xml title and the latter to check repo.xml description

• the generator also conflates name and description, so in the package repo, this package's title is its description. tests pass now, but the generator and its tests of this should be updated. also affects https://github.com/joewiz/airlock.

• how do you keep all of the version numbers aligned between expath-pkg.xml, package.json, and README.md? README.md, for example, lists the current release, but if the current development version is x.y.z-SNAPSHOT, that won't be the current release.

• the generator asks about "the beginning of your module namespace", but it's not clear from the generator what this is used for and how the actual namespaces are determined. also, the answer is used for the package name too - and really the package name should be different from the module namespace.

I have tests, but as all functions speak to the Airtable API, tests need an API key. So I would need to figure out how to store encrypted secrets in GitHub Actions—that's explained here: https://docs.github.com/en/actions/reference/encrypted-secrets—and then expose these secrets for the test runner.