string is

문자열-입니다

String.is는 개발자를위한 오픈 소스의 개인 정보 보호 친화적 인 툴킷입니다. 여기서 실제로 볼 수 있습니다.

String.is는 다음과 같은 목표를 가진 의견이있는 전환 도구입니다.

• 오픈 소스 여야합니다.
• 쿠키를 설정해서는 안됩니다.
• 엄격한 컨텐츠 보안 정책이 있어야합니다.
• 의존성에 대해 매우 의견이 있어야하며 잘 알려진 잘 지원되는 라이브러리 만 사용해야합니다.
• 입력 형식을 감지하고 출력 옵션을 지능적으로 선택해야합니다.

브라우저 지원

String.s는 Chrome, Safari, Firefox 및 Edge에서 작동하는 것으로 확인되었습니다. 인터넷 익스플로러는 지원되지 않습니다.

현지에서 실행

종속성 설치 :

yarn install

GIT 후크 설정 :

yarn husky install

개발 서버 실행 :

yarn dev

... 그런 다음 브라우저에서 http : // localhost : 3000을 엽니 다.

모든 라인 체크를 실행하려면 생산을위한 체크, 테스트 및 빌드를 입력하십시오.

yarn all

Docker와 함께 달리기

Docker 이미지 구축 :

yarn docker-build

또는

docker build -t string-is .

... 그런 다음 실행하십시오.

yarn docker-run

또는

docker run -p 3000:3000 string-is

또는 docker-compose 로 빌드 및 실행할 수 있습니다.

docker-compose up

... 또는 Docker Hub에서 직접 실행하십시오.

docker run -p 3000:3000 daveperrett/string-is:latest

현재 linux/arm64 및 linux/amd64 플랫폼이 지원됩니다.

새 변환기 추가

src/lib 폴더에는 대부분의 변환 로직이 포함되어 있으며 반응 지식이 필요하지 않은 순수한 타입 스크립트입니다.

• src/lib/identities 입력 문자열을 취하고 입력이 특정 형식 인 신뢰도 수준을 반환하는 식별자가 포함되어 있습니다. 예를 들어, JwtIdentifier 주어진 입력 문자열이 JWT 토큰임을 신뢰 수준 (0과 100 사이)을 나타내는 숫자를 반환합니다.
• src/lib/inputs 다른 형식의 문자열을로드하는 파서가 포함되어 있습니다. 예를 들어, JsonInput 는 JSON 문자열을 구문 분석하고 객체를 반환합니다.
• src/lib/outputs 구문 분석 데이터를 가져 와서 특정 출력 형식으로 형식화합니다. 예를 들어, JavaScriptOutput JavaScript String을 사용하여 제공된 서식 옵션에 따라 형식을 형식화하고 결과를 반환합니다.
• src/lib/converters 입력 → 출력 쌍 - 형식간에 변환을 수행하는 접착제입니다. 예를 들어, CsvToJsonConverter 입력으로 CSV 문자열을 가져 와서 구문 분석을 위해 CsvInput 에 공급하며 결과를 형식을위한 JsonOutput 에 파이프합니다.

새 변환기를 추가하려면 :

1. 변환 하는 형식을 결정하십시오. 예를 들어, 일반 텍스트 에서 반전 텍스트 로 변환기를 작성하는 척하겠습니다.
2. FROM 형식에 대한 identity (SRC/LIB/ID)이 있는지 확인하십시오. 이 경우 우리는 평범한 텍스트에서 변환하고 있으며 이미 평범함이 있으므로 새로운 정체성을 추가 할 필요가 없습니다. identity (a) 입력 문자열이 주어지면 주어진 입력이 신원과 일치한다는 신뢰를 설명하는 100 개 중 숫자를 반환하는 confidence 함수와 (b) 신원을 사용할 수있는 다양한 converters 배열을 내보내야합니다.
3. 단계 (2)에 새로운 identity 추가 한 경우 SRC/LIB/ID/INDEX.TS로 내보내십시오.
4. TO 형식에 대한 output (SRC/LIB/출력 아래)이 있는지 확인하십시오. 출력은 입력 문자열 (또는 전환이 발생하는 변환에 따라 개체)과 options 개체가 주어지면 입력을 원하는 출력 문자열로 변환하는 output 함수를 내보내야합니다.
5. 단계 (4)에 새 output 추가 한 경우 SRC/LIB/OUTPUTS/Index.ts로 내보내십시오.
6. input + output 쌍에 새 converter (SRC/LIB/변환기 아래)를 추가하십시오. 변환기는 (a) 입력 문자열을 전달하는 operation 함수와 options 개체를 적절한 output 으로 전달하고 (b) 사용되는 출력을 정의하는 outputId 합니다.
7. 단계 (6)에 새 converter 추가 한 경우 SRC/LIB/Converters/Index.ts에서 내보내십시오. 또한 자동 생성 된 방문 페이지에 올바른 제목, 인트로 텍스트 및 예제가 있도록 로컬/en/pages-converter.json에 항목을 추가하십시오.
8. 단계 (6)에서 새 outputId 정의한 경우 새 유형의 출력을 렌더링하기 위해 반응 출력 구성 요소 (SRC/구성 요소/도메인/변환/출력 하에서)를 추가하십시오. 기존 종류의 출력 (예 : JSON 또는 YAML로 변환)을 재사용하는 경우 여기에서 기존 출력 구성 요소를 재사용 할 수 있습니다.
9. 단계 (8)에 새 React 구성 요소를 추가 한 경우 SRC/구성 요소/도메인/변환/출력으로 내보내십시오.

적절한 inputs , outputs , converters 및 반응 구성 요소가 제자리에 있고 올바르게 내보내면 0이 아닌 confidence 트리거하는 적절한 입력 문자열이 주어지면 새 변환기를 사용할 수 있어야합니다.

전개

개인 정보가 보호되었다고 100% 확신하려면 문자열을 쉽게 설정할 수 있습니다.

string.is를 배포하는 가장 빠른 방법은 Vercel 플랫폼을 사용하는 것입니다 (비상업적 사용은 무료입니다). 자세한 내용은 Next.js 배포 문서를 확인하십시오. 아래 Deploy 버튼을 클릭 하여이 응용 프로그램을 Vercel으로 배포하십시오.

Netlify와 Heroku는 또한 무료 호스팅을위한 좋은 옵션입니다. 아래 Deploy 버튼을 클릭하여 Heroku를 사용 하여이 응용 프로그램을 배포하십시오.

불행히도 String.is i18n 현재 next export 통해 정적 빌드를 지원하지 않습니다 (예 : S3에서 호스팅 할 수 있음).

배포 string.s는 도메인의 하위 경로 아래에 있습니다

NEXT_PUBLIC_BASE_PATH 환경 변수를 하위 경로로 설정 한 다음 배포하기 전에 프로젝트를 작성하십시오. 이 값은 빌드 타임에 설정해야하며 클라이언트 측 번들에 값이 상감되므로 재건축 없이는 변경할 수 없습니다.

예를 들어, https://tools.example.com/string-is 에 배포하는 경우 NEXT_PUBLIC_BASE_PATH /string-is 로 설정해야합니다. 도메인의 루트에 배포하는 경우이 변수를 설정할 필요가 없습니다.

Docker와 함께 빌드 및 실행 :

docker build -t string-is --build-arg NEXT_PUBLIC_BASE_PATH= " /string-is " .
docker run -p 3000:3000 string-is

또는 docker-compose 로 빌드하고 실행하십시오.

 export NEXT_PUBLIC_BASE_PATH= " /string-is "
docker-compose up --build

현지화

String.is는 전체 현지화를 지원합니다. 새로운 언어는 locales/ Folder에 JSON 형식으로 추가해야합니다 (예를 들어 locales/en/ 참조). 영어는 현재 제공되는 유일한 로케일이지만 새로운 언어에 대한 지원을 환영합니다.

해석학

String.is에는 개인 정보 친화적 인 쿠키가없는 분석 서비스 인 Plausible Analytics에 대한 지원이 포함되어 있습니다. 이를 가능하게하려면 도메인을 지정하는 환경 변수를 설정하십시오.

 NEXT_PUBLIC_ANALYTICS_DOMAIN=string.is

process.env.NODE_ENV === 'production' 및 NEXT_PUBLIC_ANALYTICS_DOMAIN 도메인이 설정되지 않는 한 분석법은 기본적으로 비활성화됩니다.

기여

변경 한 후에 :

1. 포크 스트링-입니다
2. 주제 지점 git checkout -b feature/add-my-new-converter 만듭니다
3. 분기- git push origin feature/add-my-new-converter 로 푸시하십시오
4. 지점에서 풀 요청을 만듭니다
5. 그게 다야!

작가

@davemetrics

라이센스

자세한 내용은 라이센스를 참조하십시오.