Skip to content

Rename Coq references to Rocq/Waterproof/code#86

Open
Tammo0987 wants to merge 3 commits into
mappingfrom
feat/rename-coq-references
Open

Rename Coq references to Rocq/Waterproof/code#86
Tammo0987 wants to merge 3 commits into
mappingfrom
feat/rename-coq-references

Conversation

@Tammo0987
Copy link
Copy Markdown
Contributor

@Tammo0987 Tammo0987 commented Mar 31, 2026

Description

Renames internal Coq references to Waterproof (editor/UI) or Rocq (language/LSP) for naming consistency across the codebase.

Testing this PR

Pure rename refactor with no behavioral changes. npm run build passes.

Closes impermeable/waterproof-vscode#322

Copilot AI review requested due to automatic review settings March 31, 2026 15:23
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Renames internal “Coq” terminology to “Rocq” (language/LSP) or more generic “code” wording (UI/editor) to improve naming consistency across the editor and related modules.

Changes:

  • Update in-code comments/docstrings to use “Rocq” or “code” instead of “Coq”.
  • Rename the code block view factory (createCoqCodeViewcreateCodeBlockView) and related plugin-spec identifier.
  • Rename CodeMirror theme import and add a new codeTheme.json theme file.

Reviewed changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/qedStatus.ts Updates proof-status-related comments from Coq → Rocq.
src/menubar/menubar.ts Updates a DEBUG menu comment to reflect Rocq/code terminology.
src/markup-views/switchable-view/EditableView.ts Updates completion-related comment wording (coqdoc → rocqdoc).
src/markup-views/index.ts Updates module comment to reflect the actual export (switchable view plugin).
src/embedded-codemirror/embeddedCodemirror.ts Updates embedded editor doc/comment text to “Rocq code” / “code cell”.
src/editor.ts Updates diagnostic type comment + internal comments from “coq” → “code”.
src/document/blocks/schema.ts Updates schema helper comment from “coqcode” → “code”.
src/codeview/nodeview.ts Updates comments/docstrings to reflect Rocq terminology.
src/codeview/index.ts Updates export comment from “coq plugin” → “code plugin”.
src/codeview/color-scheme.ts Switches theme import from coqTheme.json to codeTheme.json.
src/codeview/codeTheme.json Adds the renamed CodeMirror theme JSON.
src/codeview/code-plugin.ts Renames the code-block NodeView factory and plugin-spec identifier.
src/api/types.ts Updates API doc comment listing supported block types (CoqBlock → CodeBlock).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/api/types.ts
* A `WaterproofDocument` is a collection of `Block`s. Every Block in this WaterproofDocument will get translated into some ProseMirror node.
*
* Supported blocks are `HintBlock`, `InputAreaBlock`, `MarkdownBlock`, `CoqBlock` and `MathDisplayBlock`.
* Supported blocks are `HintBlock`, `InputAreaBlock`, `MarkdownBlock`, `CodeBlock` and `MathDisplayBlock`.
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment now refers to CodeBlock, but the linked documentation (documentation/UsingWaterproofEditor.md) still documents CoqBlock as part of the WaterproofDocument grammar. Either update the docs in the same rename sweep or adjust this comment to match the current public documentation to avoid confusing API consumers.

Suggested change
* Supported blocks are `HintBlock`, `InputAreaBlock`, `MarkdownBlock`, `CodeBlock` and `MathDisplayBlock`.
* Supported blocks are `HintBlock`, `InputAreaBlock`, `MarkdownBlock`, `CoqBlock` and `MathDisplayBlock`.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the comment is right (but the proposed solution isn't), because the class is called CodeBlock already, so I updated more of the documentation to fix it.

Comment thread src/codeview/nodeview.ts
@pimotte
Copy link
Copy Markdown
Contributor

pimotte commented Apr 20, 2026

On hold until mapping merge

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.

3 participants