Refactor terminology from "plugin" to "package" in documentation and code examples

Author: max-ostapenko

CHANGELOG.md

@@ -19,17 +19,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Security
 
-## [0.0.2] - 2025-10-06
-
-### Fixed
-
-- Corrected usage instructions in README for clarity
-
-## [0.0.1] - 2025-09-16
+## [0.0.1] - 2025-10-06
 
 ### Added
 
-- Initial release of the Dataform Plugin
+- Initial release of the Dataform Package
 - Automatic BigQuery reservation assignment based on action names
 - Support for high-priority, low-priority, and on-demand reservations
 - Comprehensive test suite with Jest

CONTRIBUTING.md

@@ -7,8 +7,8 @@ We welcome contributions to the Dataform Plugin! This document provides guidelin
 1. **Clone the repository:**
 
    ```bash
-   git clone https://github.com/masthead-data/dataform-plugin.git
-   cd dataform-plugin
+   git clone https://github.com/masthead-data/dataform-package.git
+   cd dataform-package
    ```
 
 2. **Install dependencies:**
@@ -32,8 +32,8 @@ We welcome contributions to the Dataform Plugin! This document provides guidelin
 ## Project Structure
 
 ```filetree
-dataform-plugin/
-├── index.js              # Main plugin code
+dataform-package/
+├── index.js              # Main package code
 ├── test/
 │   └── index.test.js     # Test suite
 ├── package.json          # Package configuration
@@ -133,4 +133,4 @@ If you have questions about contributing, please:
 2. Open a new issue for discussion
 3. Contact the maintainers
 
-Thank you for contributing to the Dataform Reservation Plugin!
+Thank you for contributing to the Dataform Plugin!

README.md

@@ -1,10 +1,10 @@
 # Masthead Plugin for Dataform
 
-[![npm version](https://badge.fury.io/js/%40masthead-data%2Fdataform-plugin.svg)](https://badge.fury.io/js/%40masthead-data%2Fdataform-plugin)
+[![npm version](https://badge.fury.io/js/%40masthead-data%2Fdataform-package.svg)](https://badge.fury.io/js/%40masthead-data%2Fdataform-package)
 
 ## Overview
 
-This plugin is designed to optimize BigQuery resource usage by automatically assigning compute reservations to Dataform actions based on predefined configuration. This system enables businesses to efficiently manage their BigQuery costs and resource allocation with minimal manual intervention.
+This package is designed to optimize BigQuery resource usage by automatically assigning compute reservations to Dataform actions based on predefined configuration. This system enables businesses to efficiently manage their BigQuery costs and resource allocation with minimal manual intervention.
 
 ## Key Benefits
 
@@ -22,17 +22,17 @@ Add the dependency to your `package.json`:
 ```json
 {
   "dependencies": {
-    "@masthead-data/dataform-plugin": "0.0.2"
+    "@masthead-data/dataform-package": "0.0.1"
   }
 }
 ```
 
 and click **Install Packages** in Dataform UI.
 
-Then, import the plugin and create a setter function in your global scope under `/includes` directory:
+Then, import the package and create a setter function in your global scope under `/includes` directory:
 
 ```javascript
-const reservations = require("@masthead-data/dataform-plugin");
+const reservations = require("@masthead-data/dataform-package");
 
 const RESERVATION_CONFIG = [
   ...
@@ -153,12 +153,12 @@ Example implementation can be found in [https://github.com/HTTPArchive/dataform]
 
 ## Under the Hood
 
-### Action Name Detection
+### Supported Actions
 
-The plugin detects the action using two methods:
+The package supports various Dataform contexts for action name detection:
 
-* **Primary**: `ctx.self()` function (for most Dataform contexts)
-* **Fallback**: `ctx.operation.proto.target` (for operation contexts)
+* **Standard Context**: Uses `ctx.self()` to get the action name.
+* **Operation Context**: Falls back to `ctx.operation.proto.target` if `ctx.self()` is not available.
 
 ### Reservation Lookup
 

examples.js

@@ -1,9 +1,9 @@
 /**
  * Example usage of the Dataform Plugin
- * This file demonstrates various ways to use the plugin in your Dataform project
+ * This file demonstrates various ways to use the package in your Dataform project
  */
 
-const { createReservationSetter } = require('@masthead-data/dataform-plugin')
+const { createReservationSetter } = require('@masthead-data/dataform-package')
 
 // Example 1: Define your reservation configuration
 const MY_RESERVATION_CONFIG = [
@@ -60,7 +60,7 @@ SELECT * FROM source_table
 // Example 4: Usage in JavaScript Dataform files
 
 /*
-const { createReservationSetter } = require('@masthead-data/dataform-plugin')
+const { createReservationSetter } = require('@masthead-data/dataform-package')
 
 const MY_CONFIG = [
   // your configuration here

index.js

@@ -82,7 +82,7 @@ function preprocessConfig(config) {
  * @param {Array} config - Array of reservation configuration objects
  * @returns {Function} A reservation setter function that takes a Dataform context
  * @example
- * const { createReservationSetter } = require('@masthead-data/dataform-plugin')
+ * const { createReservationSetter } = require('@masthead-data/dataform-package')
  *
  * const config = [
  *   {

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@masthead-data/dataform-plugin",
-  "version": "0.0.2",
-  "description": "Masthead Data plugin for Dataform to optimize BigQuery resource usage",
+  "name": "@masthead-data/dataform-package",
+  "version": "0.0.1",
+  "description": "Masthead Data package for Dataform to optimize BigQuery resource usage",
   "main": "index.js",
   "scripts": {
     "test": "jest",
@@ -27,12 +27,12 @@
   "license": "AGPL-3.0-only",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/masthead-data/dataform-plugin.git"
+    "url": "git+https://github.com/masthead-data/dataform-package.git"
   },
   "bugs": {
-    "url": "https://github.com/masthead-data/dataform-plugin/issues"
+    "url": "https://github.com/masthead-data/dataform-package/issues"
   },
-  "homepage": "https://github.com/masthead-data/dataform-plugin#readme",
+  "homepage": "https://github.com/masthead-data/dataform-package#readme",
   "engines": {
     "node": ">=14.0.0"
   },

test/index.test.js

@@ -3,7 +3,7 @@ const {
   getActionName
 } = require('../index')
 
-// Example configuration for testing (previously hardcoded in the plugin)
+// Example configuration for testing (previously hardcoded in the package)
 const EXAMPLE_RESERVATION_CONFIG = [
   {
     tag: 'high_slots',