maui-sdk-javascript

Hive5 Javascript SDK

CORS 이슈 해결

Play Framework

https://www.playframework.com/documentation/2.4.x/CorsFilter

min.js 만들기

아래 온라인 사이트를 이용한다. http://jscompress.com/

Documenting APIs

자동 문서화를 위해 JSDoc의 규약을 따른다.
JSDoc은 /**로 시작하는 주석만을 인식하여 처리한다.

/** 간단한 샘플 */
function foo() {
}

documentation tag를 잘 활용하면 좋다.

/** 
 * 다양한 documentation tag가 있으니 공부하여 적용할 것
 * @constructor
 * @param {string} name - Name of instance
 * @return {foo} It returns an instance of foo
 */
function foo(name) {
}

문서 생성은 jsdoc 프로그램을 이용하여 아래와 같이 생성한다.

./jsdoc hive5.js

설정 파일은 아래와 같이 설정한다.
markdown을 지원하기 위해 어떻게 하고 있는 지 주목하라.

  {
  "tags": {
      "allowUnknownTags": true
  },
  "source": {
      "includePattern": ".+\\.js(doc)?$",
      "excludePattern": "(^|\\/|\\\\)_"
  },
  "plugins": ["plugins/markdown"],
  "templates": {
      "cleverLinks": false,
      "monospaceLinks": false,
      "default": {
          "outputSourceFiles": true
      }
  }
}

}

API 레퍼런스 출력물 배포위치

phase	location
alpha	s3버킷 maui-alpha-developer/ko-kr/javascript-sdk-doc/[버전]
beta	s3버킷 maui-prod-developer/ko-kr/javascript-sdk-doc/[버전]

jsdoc

jsdoc은 아래 페이지에서 배포 중이다. https://github.com/jsdoc3/jsdoc/releases

Learn more

JSDoc에 대한 더 자세한 사항은 아래 링크를 참고하라.
http://usejsdoc.org/

Unit Test

유닛테스트를 위해 Javascript용 유닛테스트 프레임웍인 QUnit을 이용하고 있다.

유닛테스트 실행

브라우저로 hive5_unit_test.html을 열면 바로 유닛테스트가 실행된다.
Filter에 Auth 따위를 입력하면, 해당 이름이 test 제목에 포함된 test만 수행된다.

유닛테스트 추가

유닛테스트를 추가하기 위해서는 hive5_unit_test.js 파일을 수정하면 된다.
동기코드 테스트와 비동기코드 테스트 샘플을 아래 소개한다.

동기 코드를 위한 테스트 코드 샘플

QUnit.test( "Your sync something test", function( assert ) {
  var foo = bar();
  alert.ok(foo.age > 20, "Passed!");
  alert.equal(foo.name, "somebody", "Passed!");
}

비동기 코드를 위한 테스트 코드 샘플

QUnit.test( "Your async something test" function( assert ) {
  var done = assert.async();
  barAsync().then(function(result) {
    alert.ok(result.error == null), "Passed!");
    done();
  }).catch(function(error) {
    alert.ok(false, error.message);
    done();
  });
}

더 보기

QUnit에 대한 더 자세한 정보는 다음 링크를 참고하라. http://qunitjs.com/