Skip to content

Fix first-run problems in create and the README - #17

Merged
svincent240 merged 1 commit into
mainfrom
fix/first-run-polish
Oct 30, 2026
Merged

svincent240 merged 1 commit into
mainfrom
fix/first-run-polish

Conversation

@svincent240

Copy link
Copy Markdown
Contributor

Description

Fixes problems a new user hits in their first few minutes with CourseCode Framework.

  • Commands that failed: coursecode create printed bare coursecode commands, which fail after npx coursecode create when there is no global install. It now prints npx coursecode.
  • Next step: create now tells people to open the project in their AI tool. Projects created through the plugin skip that step.
  • New course metadata: New projects start at 1.0.0 instead of 2.0.0 and no longer carry the template author's name. Package metadata says "Unknown" until an author is set, the same as blank projects.
  • README: Quick Start leads with the plugin, then npx, then requirements.
  • Install output: New projects use ESLint 10, which removes the deprecation warning, and create no longer prints npm's audit or funding notices.
  • Smaller fixes: The narration help lists all five providers, and the npm homepage points to coursecodeframework.com.

The audit notice was a low-severity deepmerge advisory that comes through @xapi/cmi5. npm reports no fix for it, so it is hidden from create output, not resolved. It still appears in npm audit.

Related Issue

None.

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactoring
  • Other (describe): new project tooling (ESLint 10)

Checklist

  • I have read the CONTRIBUTING guidelines
  • My code follows the project's code style
  • I have run npm run lint and it passes
  • I have tested my changes with npm run preview
  • I have updated documentation if needed
  • My commits follow the conventional commit format

The commit follows the repository's recent commit style, not the conventional format.

Testing

  • Unit tests: 1,682 passed
  • End-to-end tests: 108 passed
  • LMS driver tests: 54 passed
  • npm run prerelease:check passed
  • A project created from a packed build ran through ESLint, lint, build, and preview with no global install

In that packed project, npx coursecode ran the published 0.4.3, because new projects install the CLI from npm. The template and create output came from this branch.

The first full run had six failures in tests/e2e/completion.e2e.test.js, and that file took nearly an hour. It then passed 23 of 23 on both main and this branch, and the full suite passed. The cause was not confirmed, so that file may be flaky.

Not tested: a full AI-built course through the plugin, Windows, or a real LMS upload.

Screenshots (if applicable)

Not applicable.

🤖 Generated with Claude Code

The commands create printed failed after npx coursecode create when
coursecode wasn't installed globally, so they now use npx. New projects
also point people to their AI tool, start at version 1.0.0, and no longer
carry the template author's name.

The README leads with the plugin. New projects use ESLint 10, create no
longer prints npm's audit and funding notices, the narration help lists
all five providers, and the npm homepage points to the site.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@svincent240
svincent240 merged commit 9c182c4 into main Oct 30, 2026
2 checks passed
@svincent240 svincent240 mentioned this pull request Oct 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant