@surrealdb/surql-fmt 0.1.0-beta.1

package/README.md

@@ -0,0 +1,68 @@
+# SurrealQL Formatter
+
+A formatter CLI and JavaScript library for formatting SurrealQL queries.
+
+## CLI Tool
+
+The CLI can be used as a standalone tool to format SurrealQL queries. It is usually installed globally and accessed via the `surqlfmt` command.
+
+### Installation
+
+The CLI tool can be installed using your preferred Node.js package manager.
+
+```bash
+npm install -g @surrealdb/surql-fmt
+```
+
+### Usage
+
+```bash
+# Format a single file
+surqlfmt ./query.surql
+
+# Check if files are formatted
+surqlfmt --check ./src/**/*.surql
+
+# Format from stdin
+cat query.surql | surqlfmt --stdin
+
+# Configure indentation and line length
+surqlfmt --indent 4 --indent-char tab --max-line-length 120 *.surql
+
+# Write files in-place
+surqlfmt --write ./src/**/*.surql
+```
+
+You can use `surqlfmt --help` to see all the available options.
+
+## Library
+
+You can also install surql-fmt as a library to format SurrealQL queries programmatically.
+
+### Installation
+
+You can install surql-fmt as a library using your preferred Node.js package manager.
+
+```bash
+npm install @surrealdb/surql-fmt
+```
+
+### Usage
+
+You can use the `format` function to format a SurrealQL query string.
+
+```ts
+import { format } from "@surrealdb/surql-fmt";
+
+// Format the query with 4 spaces indentation
+const formatted = format(query, {
+	indent: 4
+});
+```
+
+You can also use the `formatRange` function to format a range of a SurrealQL query string.
+
+```ts
+// Format characters 0 to 100 of the query
+const formatted = formatRange(query, 0, 100);
+```

package/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+We take the security of SurrealDB code, software, and cloud platform very 
+seriously. If you believe you have found a security vulnerability in 
+SurrealDB, we encourage you to let us know right away. We will investigate 
+all legitimate reports and do our best to quickly fix the problem.
+
+Please report any issues or vulnerabilities to security@surrealdb.com, 
+instead of posting a public issue in GitHub. Please include the version 
+identifier, by running `surrealdb version` on the command-line, and 
+details on how the vulnerability can be exploited.