Merge pull request #4 from yourssu/feat/#2

feat: YLS 구조 변경 및 타임스탬프 생성
yourssu · Jan 26, 2024 · ae8c130 · ae8c130
2 parents 910cd06 + 1b959e6
commit ae8c130
Showing 23 changed files with 2,979 additions and 2,304 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -0,0 +1,28 @@
+module.exports = {
+  root: true,
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+    'prettier',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh', 'react', 'prettier'],
+  rules: {
+    'react-refresh/only-export-components': ['warn', { allowConstantExport: true }],
+    'prettier/prettier': ['error', { endOfLine: 'auto' }],
+    'react/react-in-jsx-scope': 'off',
+  },
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.jsx', '.ts', '.tsx'],
+      },
+    },
+  },
+};
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,11 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+# ✅ ISSUE :
+## Description
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+# ISSUE ✅ :
+
+## 📖 Summary
+이슈를 간단히 요약해주세요
+
+
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,26 @@
-node_modules/
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
 
 .env
diff --git a/.prettierrc → .prettierrc.json b/.prettierrc → .prettierrc.json
diff --git a/index.html b/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/Logger.ts"></script>
+  </body>
+</html>
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -3,19 +3,42 @@
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
+  "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
   },
   "keywords": [],
   "author": "",
   "license": "MIT",
-  "devDependencies": {
-    "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.2",
-    "prettier": "^3.1.1"
+  "peerDependencies": {
+    "axios": "^1.6.4",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-router-dom": "^6.21.3"
   },
-  "dependencies": {
-    "axios": "^1.6.4"
+  "devDependencies": {
+    "@types/react": "^18.2.43",
+    "@types/react-dom": "^18.2.17",
+    "@types/react-router-dom": "^5.3.3",
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
+    "@vitejs/plugin-react": "^4.2.1",
+    "axios": "^1.6.4",
+    "eslint": "^8.55.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.5",
+    "prettier": "^3.0.3",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-router-dom": "^6.21.3",
+    "typescript": "^5.2.2",
+    "vite": "^5.0.8"
   }
 }
diff --git a/src/LogClick.tsx b/src/LogClick.tsx
@@ -0,0 +1,12 @@
+import { useYLSLogger } from '.';
+
+interface Props {
+  children: React.ReactNode;
+  params: LogPayloadParams;
+}
+
+export const LogClick = ({ children, params }: Props) => {
+  const logger = useYLSLogger();
+
+  return <></>;
+};
diff --git a/src/LogParamsProvider.ts b/src/LogParamsProvider.ts
@@ -0,0 +1,3 @@
+import { createContext } from 'react';
+
+const LogParamsContext = createContext(null);
diff --git a/src/LogScreen.tsx b/src/LogScreen.tsx
@@ -0,0 +1,22 @@
+import { useYLSLogger } from '.';
+import { useLocation } from 'react-router-dom';
+import { useEffect } from 'react';
+
+interface Props {
+  children: React.ReactNode;
+  params: LogPayloadParams;
+}
+
+export const LogScreen = ({ children, params }: Props) => {
+  const logger = useYLSLogger();
+  const router = useLocation();
+  const { path } = params;
+
+  useEffect(() => {
+    if (router) {
+      // logger.screen(path);
+    }
+  }, []);
+
+  return <>{children}</>;
+};
diff --git a/src/Logger.ts b/src/Logger.ts
@@ -0,0 +1,45 @@
+interface LoggerType {
+  path: string;
+  platform: string;
+  serviceName: string;
+  name: string;
+  message: string;
+}
+
+const createRandomId = () => {
+  // Todo: create random id
+};
+
+const createTimestamp = () => {
+  const offset = new Date().getTimezoneOffset() * 60 * 1000;
+  const now = new Date(Date.now() - offset);
+  return now.toISOString();
+};
+
+export const useYLSLogger = () => {
+  const screen = ({ path }: LoggerType) => {
+    // console.log(`Logging screen information for path: ${path}`);
+  };
+
+  const click = ({ name }: LoggerType) => {
+    // console.log(`Logging click information for button: ${name}`);
+  };
+
+  return {
+    screen,
+    click,
+  };
+};
+
+export const Logger = ({ path, platform, serviceName, name, message }: LoggerType) => {
+  return {
+    userId: createRandomId(),
+    timestamp: createTimestamp(),
+    event: {
+      platform,
+      serviceName,
+      name,
+      message,
+    },
+  };
+};
diff --git a/src/apis/postLog.js b/src/apis/postLog.js
diff --git a/src/Logger.js → src/apis/postLog.ts b/src/Logger.js → src/apis/postLog.ts
diff --git a/src/index.js b/src/index.js
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1 @@
+export { useYLSLogger } from './Logger';
diff --git a/src/types/LogPayloadParams.ts b/src/types/LogPayloadParams.ts
@@ -0,0 +1,6 @@
+interface LogPayloadParams {
+  path: string;
+  name: string;
+  message?: string;
+  tags?: string[];
+}
diff --git a/src/vite-env.d.ts b/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "allowJs": true,
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+  },
+  "include": ["src"],
+  "references": [{ "path": "./tsconfig.node.json" }],
+}
diff --git a/tsconfig.node.json b/tsconfig.node.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["vite.config.ts"]
+}
diff --git a/vite.config.ts b/vite.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+});
diff --git a/yarn.lock b/yarn.lock
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { createContext } from 'react';

		const LogParamsContext = createContext(null);