Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luiisp/catscript
💻✨😺 The world's first programming language made for cats
https://github.com/luiisp/catscript
Last synced: 13 days ago
JSON representation
💻✨😺 The world's first programming language made for cats
- Host: GitHub
- URL: https://github.com/luiisp/catscript
- Owner: luiisp
- Created: 2024-06-18T03:56:59.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-24T02:03:48.000Z (7 months ago)
- Last Synced: 2024-12-04T00:36:32.826Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/runcat
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# 🍷 Sintaxe
```cat
meow("Hello World!") # print "Hello world!" in the console
```
```cat
pspsps add (x, y) { # define add function
x + y # return 15
}
meow(add(10, 5)) # print 15
```
For more usage examples, check the [examples](https://github.com/luiisp/catscript/tree/main/examples)
# 📦 Installation & Usage
1. **Install the catscript interpreter**
```bash
npm install -g runcat
```
2. **Run the catscript file**
```bash
runcat file.cat
```
Done! 🎉
# 🙀 Syntax Highlighting
[Acess the Syntax Highlighting Repository](https://github.com/luiisp/catscript-syntax-highlighting)
# 🐈⬛ Learn catscript
## General
- in catscript, the `#` symbol is used to comment a line
- catscript is case-sensitive
- catscript is whitespace-insensitive
- catscript is a dynamically typed language
- return values are implicit
## Arithmetic operators
- `+`: Addition
- `-`: Subtraction
- `*`: Multiplication
- `/`: Division
- `%`: Modulus
## Types
> catscript is a dynamically typed language, so you don't need to specify the type of a variable. The interpreter will infer the type based on the value assigned to it.
- `string`: A sequence of characters
- `number`: A numeric value
- `boolean`: A logical value
- `Object`: A collection of key-value pairs
## Native functions
- `meow()`: Print a message in the console
- `timecat()`: Get the current time in ms
## Variables
To declare a variable, use the `cat` or `staticat` keyword followed by the variable name and the value.
```cat
cat name = "Pedro Luis"
staticat age = 16
```
`cat` variables are mutable, while `staticat` variables are immutable.
> [!IMPORTANT]\
> **in catscript, the ; symbol is only for declaration of variables and not is optional**
## Functions
To declare a function, use the `pspsps` keyword followed by the function name and the parameters.
```cat
pspsps add (x, y) {
x + y # return
}
```
To call a function, use the function name followed by the parameters (if you have).
```cat
meow(add(10, 5)) # print 15
```
> [!IMPORTANT]\
> **In catscript, the return value is implicit. the last value of the function is returned**
## Objects
To declare an object, use the {} in `cat` keyword or `staticat` followed by the object name and the key-value pairs.
```cat
staticat obj = {
name:"catscript",
repo:"https://github.com/luiisp/catscript",
author:{
name: "Pedro Luis Dias",
github: "https://github.com/luiisp/"
},
version:"lasted",
};
```
# 💪 Contributing
**We welcome contributions to the catscript project!** If you would like to contribute, **please follow these steps:**
1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Create a new branch for your changes.
4. Make your desired changes to the codebase.
5. Test your changes to ensure they work as expected.
6. Commit your changes and push them to your forked repository.
7. Submit a pull request to the main i18n4e repository.
Please make sure to follow our [contribution guidelines](CONTRIBUTING.md) and adhere to our [code of conduct](CODE_OF_CONDUCT.md) when contributing.
> [!IMPORTANT]\
> Before submitting your PR, ensure that the code is well formatted and follows our requirements
> *Created with ❤️ by [luiisp](https://github.com/luiisp)*