Merge pull request #22 from daymxn/dev

Initial release

.eslintrc

@@ -15,14 +15,14 @@
 	  "plugin:roblox-ts/recommended",
 	  "plugin:prettier/recommended"
 	],
-	"overrides": [{
-		"files": [ "scripts/**/*" ],
-		"rules": {
-			"roblox-ts/no-regex": 0,
-			"roblox-ts/lua-truthiness": 0
-		}
-	}],
 	"rules": {
+		"no-restricted-globals": [
+			"error",
+			{
+				"name": "expect",
+				"message": "Use @rbxts/expect instead."
+			}
+		],
 	  "headers/header-format": [
       	"error",
       	{

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "example"]
+	path = example
+	url = https://github.com/daymxn/rbxts-expect-example

.vscode/settings.json

@@ -19,4 +19,10 @@
 		"typescriptreact"
 	],
 	"testez-companion.timeout": 5,
+	"json.schemas": [
+    {
+      "url": "https://cdn.jsdelivr.net/npm/tsup/schema.json",
+      "fileMatch": ["package.json", "tsup.config.json"]
+    }
+  ]
 }

CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributing
+
+Any and all contributions are entirely welcomed! Before you contribute though, there are
+some things you should know.
+
+> [!NOTE]
+> Making public contributions to this repo means you accept the [LICENSE](LICENSE) agreement and you're contributing code that also respects the [LICENSE](LICENSE) agreement.
+
+## Getting started
+
+Make sure you've given both the [wiki](https://rbxts-expect.daymxn.com/docs/category/extension-guides) and the [API Reference](https://rbxts-expect.daymxn.com/docs/api) a read before moving forward, such that you understand the design behind **expect**.
+
+### Building
+
+Use the `build` command to build the source files.
+
+```sh
+npm run build
+```
+
+Or `watch` to watch the source files.
+
+```sh
+npm run watch
+```
+
+### Running Tests
+
+Start a watch for the test place.
+
+```sh
+npm run dev
+```
+
+Serve `test.project.json` with rojo and link with an empty base plate in roblox studio.
+
+Finally, use the shortcut `ctrl` + `:` with the [Test EZ Companion](https://github.com/tacheometry/testez-companion) plugin
+to run the tests.
+
+### API Docs
+
+API docs are built through the following tools:
+
+`api-extractor` -> `api-documenter` -> post processing (`/scripts`) -> docusaurus (`/wiki`)
+
+To host the `wiki` you'll need to scope to the `/wiki` directory and run the commands listed there.
+
+For syncing the API, you can run the `api` command from the **rbxts-expect** root directory.
+
+```sh
+npm run api
+```
+
+This will automatically extract the api, generate the docs for it, perform post processing, and copy it
+over to the wiki.
+
+## Making changes
+
+To make changes, clone the repo to your local disk.
+
+`git clone git@github.com:daymxn/rbxts-expect.git`
+
+Then, checkout to a new feature branch labeled in the following format.
+
+`git checkout -b NAME-CATEGORY-FEATURE`
+
+Where `NAME` is your *firstLast* name or your *github* username. `CATEGORY` is something like; feature or bugfix.
+And `FEATURE` is the title of the new feature (or bug) you're contributing for.
+
+After you've made changes to your local branch, and you want to submit, you can open a Pull Request (PR)
+via the [GitHub web panel](https://github.com/daymxn/rbxts-expect/compare).
+
+### Code Formatting
+
+Code in this repo is formatted according to eslint and prettier. You can use the attached `.vscode` folder for automatically formatting on file save, or you can manually run either via the command line with the `format` or `lint` scripts:
+
+```sh
+npm run format
+```
+
+### Changesets
+
+We use [changesets](https://github.com/changesets/changesets) for our release notes and version bumping.
+
+When submitting a change that should be apart of a release, you
+can run the `change` script.
+
+```sh
+npm run change
+```
+
+It will prompt you with options for setting the message and version type.
+
+#### Additional Commands
+
+Output [to stdout] a summary of the pending changes for a release.
+
+```sh
+npm run change:status
+```
+
+Export the pending changes to a `changes.json` file at the root directory.
+
+```sh
+npm run change:export
+```
+
+### Releasing
+
+To invoke a release, you'll need to pull the `main` branch
+and run the `release:version` command.
+
+```sh
+npm run release:version
+```
+
+This will automatically bump the releasing projects.
+
+After merging these changes back into `main`, you can move forward
+with the actual publishing.
+
+```sh
+npm run release
+```
+
+This will publish the releasing projects to npm, with the generated changelogs.
+
+The last step will be pushing the release tags back to the repo.
+
+```sh
+npm run release:tags
+```