Skip to content

Change name from Catacript to GatOS#70

Open
Hombre-x wants to merge 7 commits intotypelevel:mainfrom
Hombre-x:renaming
Open

Change name from Catacript to GatOS#70
Hombre-x wants to merge 7 commits intotypelevel:mainfrom
Hombre-x:renaming

Conversation

@Hombre-x
Copy link
Copy Markdown
Contributor

Renames the project name from Catscript to GatOS, including the documentation, the project examples, project tutorial, and library in general.

Copilot AI review requested due to automatic review settings April 28, 2026 00:49
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 the project from Catscript to GatOS/Gatos across the library, examples, docs, build, and CI, updating packages, object names, and published artifact coordinates accordingly.

Changes:

  • Rename core API package/object (org.typelevel.catscript.Catscriptorg.typelevel.gatos.Gatos) and update syntax extensions.
  • Update examples/tests to use the new package/object names and new default dot-directory (.catscript.gatos).
  • Update documentation, build definition, and CI workflow paths/module names to the new project name.

Reviewed changes

Copilot reviewed 26 out of 27 changed files in this pull request and generated 13 comments.

Show a summary per file
File Description
gatos/src/test/scala/org/typelevel/syntax/path/SyntaxSpec.scala Updates test package and replaces Catscript calls with Gatos.
gatos/src/test/scala/org/typelevel/GatosSpec.scala Renames test package and suite object to GatosSpec.
gatos/src/main/scala/org/typelevel.gatos/syntax/path/package.scala Switches syntax package namespace to org.typelevel.gatos and delegates to Gatos.
gatos/src/main/scala/org/typelevel.gatos/Gatos.scala Renames package and the main API object (CatscriptGatos).
examples/src/main/scala/org/typelevel/catscript/contacts/domain/flag.scala Updates example package namespace to org.typelevel.gatos.
examples/src/main/scala/org/typelevel/catscript/contacts/domain/contact.scala Updates example package namespace to org.typelevel.gatos.
examples/src/main/scala/org/typelevel/catscript/contacts/domain/argument.scala Updates example package + imports to org.typelevel.gatos.
examples/src/main/scala/org/typelevel/catscript/contacts/core/ContactManager.scala Updates example package + imports to org.typelevel.gatos.
examples/src/main/scala/org/typelevel/catscript/contacts/cli/Prompt.scala Updates example package + imports to org.typelevel.gatos.
examples/src/main/scala/org/typelevel/catscript/contacts/cli/Cli.scala Updates example package + imports to org.typelevel.gatos.
examples/src/main/scala/org/typelevel/catscript/contacts/app/App.scala Updates example package + imports; changes app data dir to .gatos.
examples/src/main/scala/org/typelevel/catscript/Uppercase.scala Updates example package namespace to org.typelevel.gatos.
examples/src/main/scala/org/typelevel/catscript/Scores.scala Updates example package namespace to org.typelevel.gatos.
examples/src/main/scala/org/typelevel/catscript/Place.scala Updates example package namespace to org.typelevel.gatos.
docs/wiki/file_reading_writing.md Renames project references and code samples from Catscript to GatOS/Gatos.
docs/wiki/file_manipulation.md Renames project references and code samples from Catscript to GatOS/Gatos.
docs/tutorial/reading_writing.md Renames tutorial snippets/imports to Gatos.
docs/tutorial/path.md Renames tutorial text from Catscript to GatOS.
docs/tutorial/file_handling.md Renames tutorial snippets/imports to Gatos.
docs/tutorial/creating_cli.md Renames tutorial narrative + example paths to GatOS/Gatos.
docs/introduction/index.md Renames intro narrative/snippets to GatOS/Gatos.
docs/index.md Renames landing page dependency + example snippet to gatos/GatOS.
docs/examples/solutions.md Renames solution snippets/imports to org.typelevel.gatos.
docs/examples/index.md Renames example snippets/imports to Gatos.
build.sbt Renames subproject from catscript to gatos (artifact + aggregation/deps).
README.md Renames README copy, badge URL, dependency coordinates, and example snippet to GatOS/gatos.
.github/workflows/ci.yml Updates cached target directory paths and ignored module names to gatos.

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

## File operations

catscript provides essential functions for renaming, moving, and copying files, allowing you to efficiently manage your data. These are especially useful in scripting scenarios.
gatos provides essential functions for renaming, moving, and copying files, allowing you to efficiently manage your data. These are especially useful in scripting scenarios.
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

Project name is capitalized as "GatOS" elsewhere in the docs; this sentence starts with lowercase "gatos", which looks inconsistent. Consider capitalizing it to match the rest of the documentation.

Suggested change
gatos provides essential functions for renaming, moving, and copying files, allowing you to efficiently manage your data. These are especially useful in scripting scenarios.
GatOS provides essential functions for renaming, moving, and copying files, allowing you to efficiently manage your data. These are especially useful in scripting scenarios.

Copilot uses AI. Check for mistakes.
Comment thread docs/examples/index.md
import scodec.Codec

import catscript.syntax.path.*
import gatos.syntax.path.*
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

Same issue here: import gatos.syntax.path.* relies on a gatos package that doesn’t exist at the root. To keep the mdoc snippet compiling, switch to org.typelevel.gatos.syntax.path.* or add import org.typelevel.gatos before using the gatos prefix.

Suggested change
import gatos.syntax.path.*
import org.typelevel.gatos.syntax.path.*

Copilot uses AI. Check for mistakes.
Comment thread README.md
Comment on lines +40 to +41
import gatos.*
import gatos.syntax.path.*
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

The mdoc example imports gatos.* / gatos.syntax.path.*, but there is no top-level gatos package in this repo (library code is under org.typelevel.gatos). This will make the snippet fail to compile during docs/README generation; switch to fully-qualified imports (e.g., org.typelevel.gatos...) or add an explicit import org.typelevel.gatos alias before using the gatos prefix.

Suggested change
import gatos.*
import gatos.syntax.path.*
import org.typelevel.gatos.*
import org.typelevel.gatos.syntax.path.*

Copilot uses AI. Check for mistakes.
Comment thread docs/index.md
Comment on lines +20 to +21
import gatos.*
import gatos.syntax.path.*
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

This mdoc snippet imports gatos.* / gatos.syntax.path.*, but the codebase does not define a top-level gatos package (the API lives under org.typelevel.gatos). As written, the example should not compile when the site is built; use fully-qualified imports or import org.typelevel.gatos first so gatos is available as an alias.

Suggested change
import gatos.*
import gatos.syntax.path.*
import org.typelevel.gatos.*
import org.typelevel.gatos.syntax.path.*

Copilot uses AI. Check for mistakes.
Comment thread docs/examples/index.md
import fs2.io.file.Path

import catscript.syntax.Catscript
import gatos.syntax.Gatos
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

import gatos.syntax.Gatos doesn’t match the project’s package layout (there’s no syntax.Gatos), so this snippet should not compile. Update the import to refer to the actual Gatos object under org.typelevel.gatos (or add the org.typelevel.gatos alias and then import/use gatos.Gatos).

Suggested change
import gatos.syntax.Gatos
import org.typelevel.gatos.Gatos

Copilot uses AI. Check for mistakes.
Comment thread docs/examples/index.md
import fs2.io.file.Path

import catscript.syntax.path.*
import gatos.syntax.path.*
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

This mdoc example uses import gatos.syntax.path.*, but gatos isn’t a top-level package in this repo; the syntax package is under org.typelevel.gatos.syntax.path. With mdoc:reset this block won’t compile unless you first introduce gatos via import org.typelevel.gatos (or just use fully-qualified imports).

Suggested change
import gatos.syntax.path.*
import org.typelevel.gatos.syntax.path.*

Copilot uses AI. Check for mistakes.
Comment thread docs/examples/index.md
import scodec.Codec

import catscript.syntax.Catscript
import gatos.syntax.Gatos
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

import gatos.syntax.Gatos is not a valid import for this project (no syntax.Gatos exists). Update this snippet to import the Gatos object from its actual package (org.typelevel.gatos) or introduce the gatos alias explicitly before importing.

Suggested change
import gatos.syntax.Gatos
import org.typelevel.gatos.Gatos

Copilot uses AI. Check for mistakes.
Comment thread docs/examples/index.md
@@ -71,7 +71,7 @@ import cats.effect.{IO, IOApp}

import fs2.io.file.Path

Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

These mdoc examples import gatos.syntax.path.*, but there is no top-level gatos package; the syntax package is org.typelevel.gatos.syntax.path. With mdoc/mdoc:reset this will not compile unless you first import org.typelevel.gatos to create the gatos alias (as done in some other docs pages).

Suggested change
import org.typelevel.gatos

Copilot uses AI. Check for mistakes.
Comment thread docs/examples/index.md
import fs2.io.file.Path

import catscript.Catscript
import gatos.Gatos
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

This mdoc:reset block imports gatos.Gatos, but the Gatos object is defined in package org.typelevel.gatos. Unless you explicitly import org.typelevel.gatos first (to introduce gatos as an alias), this import won’t resolve; prefer import org.typelevel.gatos.Gatos (or import org.typelevel.gatos then gatos.Gatos).

Suggested change
import gatos.Gatos
import org.typelevel.gatos.Gatos

Copilot uses AI. Check for mistakes.
Comment on lines 16 to 24
```scala
import catscript.syntax.path.*
import gatos.syntax.path.*
```

@:choice(static)

```scala
import catscript.Catscript
import gatos.Gatos
```
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

The tutorial suggests import gatos.syntax.path.* / import gatos.Gatos, but there is no top-level gatos package in the codebase (it’s org.typelevel.gatos). For copy/paste correctness, update these imports to the fully-qualified package (or explicitly introduce gatos as an alias via import org.typelevel.gatos before using gatos....).

Copilot uses AI. Check for mistakes.
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.

2 participants