{{ subComponents.name }}
- -
- {{ subComponents.desc }}
-
- {% for hashtag in subComponents.hashtags %}
- #{{ hashtag }}
- {% endfor %}
-
-
diff --git a/.eslintrc.js b/.eslintrc.js index 823e4f69e..b91216d4d 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,370 +1,70 @@ -/* eslint-disable @typescript-eslint/naming-convention */ +/* eslint-env node */ +/** @type {import('eslint').Linter.Config} */ module.exports = { - "env": { - "browser": true - }, - "parser": "@typescript-eslint/parser", - "parserOptions": { - "project": "tsconfig.eslint.json", - "sourceType": "module" - }, - "plugins": [ - "eslint-plugin-import", - "eslint-plugin-jsdoc", - "eslint-plugin-prefer-arrow", + root: true, + parser: "@typescript-eslint/parser", + plugins: [ "@typescript-eslint", - "@typescript-eslint/tslint" + "compat", + "es" ], - "overrides": [ - { - "files": [ - "./**/*.{ts,tsx}" - ], - "extends": [ - "plugin:@typescript-eslint/recommended", - "plugin:@typescript-eslint/recommended-requiring-type-checking", - "plugin:import/typescript" - ], - "rules": { - "@typescript-eslint/adjacent-overload-signatures": "off", - "@typescript-eslint/array-type": [ - "error", - { - "default": "array-simple" - } - ], - "@typescript-eslint/ban-types": [ - "error", - { - "types": { - "Object": { - "message": "Avoid using the `Object` type. Did you mean `object`?" - }, - "Function": { - "message": "Avoid using the `Function` type. Prefer a specific function type, like `() => void`." - }, - "Boolean": { - "message": "Avoid using the `Boolean` type. Did you mean `boolean`?" - }, - "Number": { - "message": "Avoid using the `Number` type. Did you mean `number`?" - }, - "String": { - "message": "Avoid using the `String` type. Did you mean `string`?" - }, - "Symbol": { - "message": "Avoid using the `Symbol` type. Did you mean `symbol`?" - } - } - } - ], - "@typescript-eslint/consistent-type-assertions": "error", - "@typescript-eslint/consistent-type-definitions": "error", - "@typescript-eslint/dot-notation": "error", - "@typescript-eslint/explicit-member-accessibility": [ - "error", - { - "accessibility": "explicit" - } - ], - "@typescript-eslint/indent": [ - "error", - 2, - { - "FunctionDeclaration": { - "parameters": "first" - }, - "FunctionExpression": { - "parameters": "first" - }, - "SwitchCase": 1 - } - ], - "@typescript-eslint/member-delimiter-style": [ - "error", - { - "multiline": { - "delimiter": "semi", - "requireLast": true - }, - "singleline": { - "delimiter": "semi", - "requireLast": false - } - } - ], - "@typescript-eslint/no-non-null-assertion": "off", - "@typescript-eslint/member-ordering": ["error", { - "default": [ - // Index signature - "signature", - - // Static - "public-static-method", - "protected-static-method", - "private-static-method", - - "public-static-field", - "protected-static-field", - "private-static-field", - - "public-abstract-field", - "protected-abstract-field", - "private-abstract-field", + extends: [ + "eslint:recommended", + "plugin:compat/recommended", + "plugin:es/restrict-to-es2015" + ], + settings: { + polyfills: [ + "Promise", + "XRWebGLLayer" + ] + }, + overrides: [{ + files: [ + "./**/*.{ts,tsx}" + ], + extends: [ + "plugin:@typescript-eslint/recommended" + ], + rules: { + "@typescript-eslint/no-explicit-any": "off", + "@typescript-eslint/no-empty-interface": "off", + "@typescript-eslint/no-non-null-assertion": "off", + "@typescript-eslint/explicit-module-boundary-types": "off", + "@typescript-eslint/ban-types": "off", + "@typescript-eslint/no-inferrable-types": "off", + "@typescript-eslint/no-this-alias": "off", + "@typescript-eslint/member-ordering": ["error", { + "default": [ + // Index signature + "signature", - "public-instance-field", - "protected-instance-field", - "private-instance-field", + "public-static-method", + "protected-static-method", + "private-static-method", - "constructor", + "constructor", - // Methods - "public-abstract-method", - "protected-abstract-method", - "private-abstract-method", + "public-abstract-method", + "protected-abstract-method", + "private-abstract-method", - "public-instance-method", - "protected-instance-method", - "private-instance-method" - ] - }], - "@typescript-eslint/no-empty-function": "error", - "@typescript-eslint/no-empty-interface": "warn", - "@typescript-eslint/no-explicit-any": "off", - "@typescript-eslint/no-misused-new": "off", - "@typescript-eslint/no-misused-promises": "off", - "@typescript-eslint/no-namespace": "error", - "@typescript-eslint/no-parameter-properties": "off", - "@typescript-eslint/no-unused-expressions": "error", - "@typescript-eslint/no-use-before-define": "off", - "@typescript-eslint/no-var-requires": "error", - "@typescript-eslint/no-inferrable-types": "off", - "@typescript-eslint/prefer-for-of": "error", - "@typescript-eslint/prefer-function-type": "error", - "@typescript-eslint/prefer-namespace-keyword": "error", - "@typescript-eslint/explicit-module-boundary-types": "off", - "@typescript-eslint/restrict-template-expressions": "off", - "@typescript-eslint/unbound-method": "off", - "@typescript-eslint/quotes": [ - "error", - "double" - ], - "@typescript-eslint/semi": [ - "error", - "always" - ], - "@typescript-eslint/triple-slash-reference": [ - "error", - { - "path": "always", - "types": "prefer-import", - "lib": "always" - } - ], - "@typescript-eslint/type-annotation-spacing": "error", - "@typescript-eslint/unified-signatures": "error", - "@typescript-eslint/no-unsafe-assignment": "off", - "@typescript-eslint/no-unsafe-return": "off", - "@typescript-eslint/no-unsafe-call": "off", - "@typescript-eslint/no-unsafe-member-access": "off", - "@typescript-eslint/no-shadow": ["error"], - "@typescript-eslint/naming-convention": [ - "error", - { - "selector": "variableLike", - "format": ["camelCase"], - "leadingUnderscore": "forbid", - "trailingUnderscore": "forbid" - }, - { - "selector": "variable", - "format": ["camelCase", "UPPER_CASE"], - "modifiers": ["const"] - }, - { - "selector": "memberLike", - "modifiers": ["public"], - "format": ["camelCase"], - "leadingUnderscore": "forbid", - "trailingUnderscore": "forbid" - }, - { - "selector": "memberLike", - "modifiers": ["protected"], - "format": ["camelCase"], - "leadingUnderscore": "require", - "trailingUnderscore": "forbid" - }, - { - "selector": "memberLike", - "modifiers": ["private"], - "format": ["camelCase"], - "leadingUnderscore": "require", - "trailingUnderscore": "forbid" - }, - { - "selector": "classProperty", - "modifiers": ["static"], - "format": ["camelCase", "UPPER_CASE"] - }, - { - "selector": "classProperty", - "modifiers": ["static", "private"], - "format": ["camelCase", "UPPER_CASE"], - "leadingUnderscore": "require", - "trailingUnderscore": "forbid" - }, - { - "selector": "classMethod", - "modifiers": ["static"], - "format": ["camelCase", "UPPER_CASE"] - }, - { - "selector": "classMethod", - "modifiers": ["static", "private"], - "format": ["camelCase", "UPPER_CASE"], - "leadingUnderscore": "require", - "trailingUnderscore": "forbid" - }, - { - "selector": "property", - "modifiers": ["static"], - "format": ["UPPER_CASE"] - }, - { - "selector": "objectLiteralProperty", - "format": ["camelCase", "UPPER_CASE"] - }, - { - "selector": "objectLiteralMethod", - "format": ["camelCase", "UPPER_CASE"] - }, - { - "selector": "parameter", - "modifiers": ["unused"], - "format": ["camelCase"], - "leadingUnderscore": "allow" - }, - { - "selector": "typeLike", - "format": ["PascalCase", "UPPER_CASE"], - "leadingUnderscore": "allow" - }, - { - "selector": "typeProperty", - "format": ["camelCase", "UPPER_CASE"], - "leadingUnderscore": "allow" - } - ], - "@typescript-eslint/tslint/config": [ - "error", - { - "rules": { - "import-spacing": true, - "whitespace": [ - true, - "check-decl", - "check-operator", - "check-module", - "check-separator", - "check-rest-spread", - "check-branch", - "check-type-operator", - "check-type", - "check-typecast", - "check-preblock" - ] - } - } + "public-instance-method", + "protected-instance-method", + "private-instance-method" ] - } + }] } - ], - "rules": { - "arrow-body-style": "off", - "arrow-parens": [ - "off", - "always" - ], - "brace-style": [ - "error", - "1tbs", - { "allowSingleLine": true } - ], - "comma-dangle": [ - "error", - "never" - ], - "complexity": "off", - "constructor-super": "error", - "curly": "off", - "eol-last": "error", - "eqeqeq": [ - "error", - "smart" - ], - "guard-for-in": "off", - "id-blacklist": "off", - "id-match": "off", - "import/order": ["error", {"newlines-between": "always"}], - "jsdoc/check-alignment": "error", - "jsdoc/check-indentation": "off", - "jsdoc/newline-after-description": ["error", "never"], - "max-classes-per-file": [ - "error", - 1 - ], - "max-len": "off", - "new-parens": "error", - "no-bitwise": "off", - "no-caller": "error", - "no-cond-assign": "error", - "no-console": "warn", - "no-debugger": "error", - "no-empty": "error", - "no-eval": "error", - "no-fallthrough": "off", - "no-invalid-this": "off", - "no-multiple-empty-lines": "error", - "no-new-wrappers": "error", - "no-shadow": "off", - "no-throw-literal": "error", - "no-trailing-spaces": "error", - "no-undef-init": "error", - "no-underscore-dangle": "off", - "no-unsafe-finally": "error", - "no-unsafe-member-access": "off", - "no-unused-labels": "error", - "no-var": "error", - "object-shorthand": "off", - "one-var": [ - "error", - "never" - ], - "prefer-arrow/prefer-arrow-functions": "off", - "prefer-const": "error", - "quote-props": "off", - "radix": "error", - "space-before-function-paren": [ - "error", - { - "anonymous": "never", - "asyncArrow": "always", - "named": "never" - } - ], - "spaced-comment": [ - "error", - "always", - { - "markers": [ - "/" - ] - } - ], - "use-isnan": "error", - "valid-typeof": "off", - "lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }] + }], + rules: { + quotes: ["error", "double"], + semi: ["error", "always"], + "es/no-optional-chaining": "off", + "es/no-rest-spread-properties": "off", + "es/no-async-functions": "off", + "es/no-nullish-coalescing-operators": "off", + "es/no-object-values": "off", + "no-empty-pattern": "off" } }; diff --git a/.github/workflows/run-test.yml b/.github/workflows/run-test.yml new file mode 100644 index 000000000..024c61091 --- /dev/null +++ b/.github/workflows/run-test.yml @@ -0,0 +1,17 @@ +name: Run tests +on: [push, pull_request] +jobs: + unit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 16 + cache: "npm" + cache-dependency-path: "**/package-lock.json" + - name: install + run: npm ci + - name: run unit test + working-directory: ./packages/view360/test/unit + run: npm run test diff --git a/.gitignore b/.gitignore index 78994f917..4a8ed65b4 100644 --- a/.gitignore +++ b/.gitignore @@ -202,14 +202,12 @@ GitHub.sublime-settings !.vscode/extensions.json ### Custom ### -doc/ -report/ -temp/ -demo/_data/version.yml demo/release/ - - -packages/**/*/dist/ -declaration/ -.jekyll-cache/ dist/ +outjs/ +declaration/ +css/ +packages/*-view360/**/sass/ +TODO.md +*.pem +*.lerna-backup diff --git a/.npmignore b/.npmignore index f91c80b67..56577df8e 100644 --- a/.npmignore +++ b/.npmignore @@ -1,3 +1,106 @@ + +# Created by https://www.gitignore.io/api/node,visualstudiocode +# Edit at https://www.gitignore.io/?templates=node,visualstudiocode + +### Node ### +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-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 + +# 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/ + +# TypeScript v1 declaration files +typings/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env +.env.test + +# parcel-bundler cache (https://parceljs.org/) +.cache + +# next.js build output +.next + +# nuxt.js build output +.nuxt + +# vuepress build output +.vuepress/dist + +# Serverless directories +.serverless/ + +# FuseBox cache +.fusebox/ + +# DynamoDB Local files +.dynamodb/ + +### VisualStudioCode ### +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json + +### VisualStudioCode Patch ### +# Ignore all local history of files +.history + +# End of https://www.gitignore.io/api/node,visualstudiocode + #configs config bower.json @@ -29,5 +132,7 @@ node_modules/ .github .babelrc mocha.opts +docgen/ demo/ packages/ +docs/ diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 8ba2ac8df..000000000 --- a/.travis.yml +++ /dev/null @@ -1,24 +0,0 @@ -language: node_js -node_js: - - 12 -dist: xenial -sudo: false -before_install: - - sudo apt-get update - - sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev - - sudo apt-get install libosmesa6 - - apt-cache policy libosmesa6 - - sudo ln -s /usr/lib/x86_64-linux-gnu/libOSMesa.so.6 /opt/google/chrome/libosmesa.so -install: - - npm install -addons: - chrome: stable -cache: - directories: - - "node_modules" -before_script: - - npm run lint -script: - - npm run coverage -after_success: - - npm run coveralls diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..45d257b29 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/LICENSE b/LICENSE index 35721db28..b8769405d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2017-present NAVER Corp. +Copyright (c) 2023-present NAVER Corp. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/NOTICE b/NOTICE index 7f8c5a039..e0d4f0d9b 100644 --- a/NOTICE +++ b/NOTICE @@ -1,7 +1,7 @@ egjs-view360 -Copyright 2017 NAVER Corp. +Copyright 2022 NAVER Corp. -This project contains subcomponents with separate copyright notices and license terms. +This project contains subcomponents with separate copyright notices and license terms. Your use of the source code for these subcomponents is subject to the terms and conditions of the following licenses. ===== @@ -93,7 +93,7 @@ with others. The OFL allows the licensed fonts to be used, studied, modified and redistributed freely as long as they are not sold by themselves. The -fonts, including any derivative works, can be bundled, embedded, +fonts, including any derivative works, can be bundled, embedded, redistributed and/or sold with any software provided that any reserved names are not used by derivative works. The fonts and derivatives, however, cannot be released under any other type of license. The diff --git a/README.md b/README.md index 6df3ccc37..67ac1adf3 100644 --- a/README.md +++ b/README.md @@ -1,203 +1,72 @@ -# egjs-view360 -
- -egjs-view360 is a 360 integrated viewing solution from **inside-out view** to **outside-in view**. It provides user-friendly service by rotating 360 degrees through various user interaction such as motion sensor and touch. - -## User Guide -- [Getting Started and Demos Website](https://naver.github.io/egjs-view360) -- [API documentation](https://naver.github.io/egjs-view360/release/latest/doc/) -- [Wiki Guide](https://github.com/naver/egjs-view360/wiki) - -## What view360 can do? - - 1. Play various (Image / Video) **360 contents** - - Smartphone Panorama pictures - - Equirectangular (Stereoscopic Also) - - Cubemap with user custom setting - - Also support YouTube **EAC** (Cubemap) Format - - Sprite image captured around target object. - 1. Control with various input type - - Motion control with device gyro sensor - - Touch (Panning, Pinch-Zoom) - - Mouse Move, Wheel - - Keyboard (Arrow key, AWDS Key) - - -## Components -egjs-view360 provides the following components. - -| |PanoViewer|SpinViewer| -|---|---|---| -|View|Inside-out|Outside-in| -|Example| || - -### [PanoViewer](https://naver.github.io/egjs-view360/panoviewer.html) ([Wiki Doc](https://github.com/naver/egjs-view360/wiki/PanoViewer-3.0-User-Guide)) - -> Following movie was recorded on iPhone 6+(It's REAL!) ++ + + + +
-## Dependency +Dynamic Text
- -Dynamic Text
- -Dynamic Text
- -{{ site.data.egjs.desc }}
- {{ site.data.egjs.hashtag }}
-
{{ site.data.egjs.desc }}
-
- {{ subComponents.desc }}
-
- {% for hashtag in subComponents.hashtags %}
- #{{ hashtag }}
- {% endfor %}
-
-
{{ subComponent.desc }}
-
- {% for hashtag in subComponent.hashtags %}
- #{{ hashtag }}
- {% endfor %}
-
-
PanoViewer offers five projection types. You can see video with the projection.
-{{projection.name}}
- -{{projection.description}}
-{{demo.name}}
- -
Don't see your project? Post an issue with built-with-view360 label over on the github page.
-
{{ subComponent.desc }}
-
- {% for hashtag in subComponent.hashtags %}
- #{{ hashtag }}
- {% endfor %}
-
-
- Features / - Getting Started - - {% if subComponent.tools %} - / Tools - {% endif %} - {% if subComponent.examples %} - / Examples - {% endif %} - {% if subComponent.projects %} - / Projects - {% endif %} -
-
Don't see your project? Post an issue with built-with-view360 label over on the github page.
-