interacter 1.0.0 → 1.0.2

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -1 +1,52 @@
-# IOS
+# Interacter | IOS
+Interacter is a module that helps dev in performing input and output operation, which values can be stored and later used for manipulation
+
+## Example
+```js
+import Input from "./ios.js";
+import { main, writeLine } from "./ios.js";
+
+main (async () => {
+
+  const username = new Input();
+  const password = new Input();
+  
+  await username.readl("Enter your username: ");
+  await password.readl("Enter your password: ");
+  
+  writeLine(username.value, password.value);
+
+});
+```
+## Features
+- Live input read
+- Character restrict
+  ### Example
+  ```js
+    main(async() => {
+
+    const a = new Input();
+
+    a.readl("Enter anything except a: ", keypress((key) => {
+      if (key === "a") {
+        a.alt("a"); //restict the character a
+      }
+  })
+  });
+  ```
+- Store value
+
+Installation `npm install interacter`;
+Importation `import Input from "./ios"`
+
+## Modules
+- Input
+- writeLine: Just as console.log() but plain
+- int: convert to integer numbers
+- keypress: listen to keyboard event
+- main
+
+### Note
+All module should be used within the main module for proper behavour.
+
+  

package/exp.js

@@ -1,10 +1,11 @@
-import {highlight, main, int, Input, writeLine, keyPress} from "./IOS.js";
+import Input, {highlight, main, int, writeLine, keyPress} from "./IOS.js";
 import {colors} from "./colors.js";
 
 
 //usage
 main(async () => {
 
+
     const y = new Input();
 
     //accepting input from user

package/ios.js

@@ -2,7 +2,7 @@ import { colors } from "./colors.js"
 let c = new colors();
 
 
-export class Input {
+export default class Input {
 
     constructor() {
         this.input = "";
@@ -158,6 +158,7 @@ export async function writeLine(...arg) {
 }
 
 
+/**Under construction */
 export const highlight = (arg, prmpt) => {
 
     process.stdout.write('\r\x1b[2K');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "interacter",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": " A simple package that allows dev to interact with the CLI by accepting user input and displaying output with customizable behavour like restricting the some characters. It can live listen to user input to prevent so",
   "keywords": [
     "input",
@@ -28,5 +28,8 @@
   "main": "ios.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "interacter": "^1.0.0"
   }
 }

package/test.js

@@ -1,5 +1,14 @@
+import { writeLine } from "./IOS.js";
+import {Input} from "./node_modules/interacter/ios.js"
+import { main } from "./node_modules/interacter/ios.js"
 
-let value = "hey how are you"
-let g = value.split(" ", 2)
 
-console.log(g);
+main(async () => {
+    const username = new Input();
+    const password = new Input();
+
+    await username.readl("Enter username: ");
+    await password.readl("Enter password: ");
+
+    writeLine(username.value, password.value)
+})