Implemented WW Timer Library with Play, Stop, and Pause APIs via WebSocket (#1)

* Feat: created WW Timer

* Other: Added eslint rules

* Other: Eslint 규칙 추가

* Other: Added husky

* BREAKING CHANGES: changed 'play' method name to 'start'

* Docs: API 변경 사항 반영

* Other: updated for npm deploy

* Other: keywords 정의

* Refactor: Rename play method to start in WWTimer class

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.

* Add: rollup configuration for ES module bundling

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.

* Add: workflow for deploying package to NPM with version confirmation

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.

* Update: build script and add Rollup as a dev dependency

- 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

* Add: registry-url and NODE_AUTH_TOKEN for NPM deployment workflow

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

* Remove: deploy script from package.json

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.

* Update: deployment command to use npm directly in GitHub Actions

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

* Add: Added LISENCE File

Author: univdev

.DS_Store

@@ -0,0 +1,47 @@
+module.exports = {
+  root: true,
+  env: {
+    browser: true,
+    es2021: true
+  },
+  extends: [
+    'airbnb-base',
+    'eslint:recommended'
+  ],
+  plugins: [
+    'import'
+  ],
+  overrides: [
+    {
+      env: {
+        node: true
+      },
+      files: [
+        '.eslintrc.{js,cjs}'
+      ],
+      parserOptions: {
+        sourceType: 'script'
+      }
+    }
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module'
+  },
+  rules: {
+    indent: ['error', 2],
+    'linebreak-style': ['error', 'unix'],
+    quotes: ['error', 'single'],
+    semi: ['error', 'always'],
+    'comma-dangle': ['error', {
+      arrays: 'never',
+      objects: 'never',
+      imports: 'never',
+      exports: 'never',
+      functions: 'never'
+    }],
+    'no-restricted-globals': ['off'],
+    'import/prefer-default-export': ['off']
+  },
+  ignorePatterns: ['examples/', 'dist/', 'node_modules/', '**/*.d.ts']
+};

.eslintrc.js

@@ -0,0 +1,32 @@
+name: Deploy package on NPM
+on:
+  workflow_dispatch:
+    inputs:
+      isConfirmed:
+        description: "Which version do you want to deploy? (ex. 1.0.0)"
+        required: true
+        type: boolean
+jobs:
+  deploy-package-on-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: "yarn"
+          registry-url: "https://registry.npmjs.org"
+      - name: Validate Tag
+        if: ${{ (github.ref_type != 'tag' || inputs.IS_CONFIRMED == 'false') }}
+        run: |
+          exit 1
+      - name: Install dependencies
+        run: yarn
+      - name: Lint
+        run: yarn lint
+      - name: Build
+        run: yarn build
+      - name: Deploy
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/deploy.yaml

@@ -0,0 +1,144 @@
+# Created by https://www.toptal.com/developers/gitignore/api/node
+# Edit at https://www.toptal.com/developers/gitignore?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+# End of https://www.toptal.com/developers/gitignore/api/node

.gitignore

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+yarn lint

.husky/pre-commit

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+PROHIBITED_REF="refs/heads/master"
+
+if read local_ref local_sha remote_ref remote_sha
+then
+    if [ "$remote_ref" = "$PROHIBITED_REF" ]
+    then
+        echo "prevent to push master"
+        exit 1
+    fi
+fi
+
+exit 0

.husky/pre-push

@@ -0,0 +1,4 @@
+.gitignore
+.git/
+node_modules/
+npm-debug.log

.npmignore

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 univdev<[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LISENCE

@@ -1,7 +1,58 @@
 ![WW Timer](./banner.jpg)
-# Introduce
-The 'WW Timer' is a timer for browsers that operate using web workers.
-# Why need
-Implementing a timer in a browser is challenging for a variety of reasons.
-- Accurate time calculation may be difficult depending on the congestion level of the event loop.
-- Browser operating in the background does not have 'setInterval' or 'setTimeout' working properly.
+# WW Timer
+WW Timer is a highly accurate timer library for web browsers.
+
+## Why It's Needed
+Typically, when implementing timer functionality in web browsers, the `setTimeout` or `setInterval` methods are used. However, due to the nature of JavaScript's execution model, achieving precise time measurement can be challenging.
+
+JavaScript's asynchronous functions are subject to delays depending on the number of tasks the web browser is executing. This can result in the `setTimeout` and `setInterval` functions being deprioritized in the event loop, which, while generally inconsequential for standard functionality, can introduce critical errors in timing accuracy for timer implementations.
+
+## Solution
+The solution lies in utilizing the [Web Worker API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) supported by browsers. Since Web Workers operate independently of the browser's main thread, they are not affected by the complexity of the tasks being executed in the web app. This independence allows for more accurate time measurements, irrespective of the main thread's load.
+
+## Features
+- **Accuracy**: Provides highly accurate timing by circumventing the event loop's congestion.
+- **Independence**: Operates separately from the main thread, ensuring timer precision is maintained.
+- **Ease of Use**: Designed to be straightforward to implement within any web application.
+
+## Installation
+```sh
+# npm
+npm install ww-timer
+# yarn
+yarn add ww-timer
+```
+
+## Quick Start
+```javascript
+// Import WW Timer
+import WWTimer from 'ww-timer';
+
+// Create a new timer
+const timer = new WWTimer();
+
+// Start the timer with a callback function
+timer.start(() => {
+  console.log('Timer tick');
+});
+
+// Pause the timer
+timer.pause();
+
+// Destroy the timer instance
+timer.destroy();
+```
+
+## API Reference
+- `start(callback, interval)`: Starts the timer with the specified callback function and interval.
+- `pause()`: Stops the timer.
+- `destroy()`: Destroy the timer instance.
+
+## Compatibility
+Compatible with most modern web browsers that support the Web Workers API.
+
+## Contributing
+Contributions to the WW Timer project are welcome. Please refer to the CONTRIBUTING.md file for more details.
+
+## License
+WW Timer is released under the MIT License. See the LICENSE file for more information.