Implemented WW Timer Library with Play, Stop, and Pause APIs via WebSocket #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit renames the `play` method to `start` in the WWTimer class to better reflect the action being performed by the method. The change aims to improve code readability and make the method's purpose more intuitive, especially for developers familiar with common naming conventions for starting processes or activities. All references to the `play` method have been updated to `start`, ensuring consistency throughout the codebase. No functionality has been altered by this renaming.
Added a rollup.config.js file to configure the bundling process for the WWTimer project. This configuration specifies 'src/index.js' as the entry point and outputs the bundled file in ES module format to 'dist/ww-timer.js'. This setup ensures the project is bundled efficiently for use with modern JavaScript module systems.
This commit introduces a new GitHub Actions workflow to automate the process of deploying our package to NPM. It requires a manual trigger through the GitHub UI, where the user is prompted to confirm the version they wish to deploy. This ensures that deployments are intentional and verified. The workflow includes steps for checking out the code, setting up Node.js, validating the tag, installing dependencies, linting, building, and finally deploying the package to NPM.
- Simplified the "build" script in package.json to use the rollup configuration file by changing it to "rollup -c". This change leverages the rollup.config.js file for the build process, making the build script cleaner and more maintainable. - Added Rollup as a development dependency to ensure a consistent build process across different environments. This addition aids in maintaining the build setup within the project's ecosystem without requiring
Enhanced the NPM deployment GitHub Actions workflow by specifying the `registry-url` for the `actions/setup-node` step and including the `NODE_AUTH_TOKEN` environment variable in the deploy step. These changes ensure that the workflow has the necessary configurations to authenticate and publish the package to the NPM registry securely. The `registry-url` is set to "https://registry.npmjs.org", aligning the deployment process with the official NPM registry
The "deploy" script has been removed from the `package.json` to streamline the project's scripts. This change reflects a shift towards utilizing external CI/CD pipelines or manual commands for deployment processes, adhering to a cleaner and more focused `package.json` structure. Adjustments were made to ensure the project's build and development lifecycle scripts remain concise and relevant to common development workflows.
Changed the deployment command in the 'Deploy package on NPM' GitHub Actions workflow from `yarn publish` to `npm publish`. This adjustment ensures direct utilization of npm for the publishing process, leveraging the `NODE_AUTH_TOKEN` environment variable for authentication. This modification aligns the deployment step more closely with npm
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the implementation of the WW Timer library, including functionalities such as play, stop, and pause APIs. The timer functionality is integrated using WebSocket, enabling real-time time tracking and management. This update enhances the library's usability and flexibility for various applications and environments.