iztro

<div align="center"> ![banner2](https://github.com/SylarLong/iztro/assets/6510425/e8457a88-e52e-435e-8f93-e3f375486d70) 一套轻量级紫微斗数排盘工具库。 </div> <div align="center"> [![Maintainability](https://api.codeclimate.com/v1/badges/b57f0e6e2e8875ce39ae/maintainability)](https://codeclimate.com/github/SylarLong/iztro/maintainability) [![Codecov](https://yellow-cdn.veclightyear.com/87312a0a/1f62ca25-7581-4b25-a269-cf8ff3334e20.svg)](https://github.com/SylarLong/iztro/actions/workflows/Codecov.yaml) [![npm](https://img.shields.io/npm/v/iztro?logo=npm&logoColor=%23CB3837)](https://www.npmjs.com/package/iztro) ![Codecov](https://img.shields.io/codecov/c/github/SylarLong/iztro?logo=codecov&logoColor=%23F01F7A) [![npm](https://yellow-cdn.veclightyear.com/87312a0a/09ec419a-f59d-48f8-ad09-ffe3bb418385.svg?logo=npm&logoColor=%23CB3837)](https://www.npmjs.com/package/iztro) [![GitHub](https://img.shields.io/github/license/sylarlong/iztro)](https://www.npmjs.com/package/iztro) [![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/SylarLong/iztro)](https://www.npmjs.com/package/iztro) [![npm bundle size](https://img.shields.io/bundlephobia/min/iztro)](https://www.npmjs.com/package/iztro) [![FOSSA Status](https://yellow-cdn.veclightyear.com/87312a0a/2663c178-911a-4eb8-ac92-7242085f9f04.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FSylarLong%2Fiztro?ref=badge_shield) [![Package Quality](https://yellow-cdn.veclightyear.com/87312a0a/600fed9d-3eb6-4d5a-93b0-3fc484f1fea4.svg)](https://packagequality.com/#?package=iztro) [![](https://data.jsdelivr.com/v1/package/npm/iztro/badge)](https://www.jsdelivr.com/package/npm/iztro) </div> --- <div align="center"> 简体中文 🔸 [繁體中文](./README-zh_TW.md) 🔸 [English](./README-en_US.md) </div> --- ### 介绍这是一个用于紫微斗数排盘的JavaScript开源库，具有以下功能。 - 输入 - 生日（阳历或农历均可） - 出生时间 - 性别 - 可以实现以下功能 - 紫微斗数12宫的星盘数据 - 获取生肖 - 获取星座 - 获取四柱（干支纪年法的生辰） - 获取运限（大限，小限，流年，流月，流日，流时）的数据 - 获取流耀（大限和流年的动态星耀） - 判断指定宫位是否存在某些星耀 - 判断指定宫位三方四正是否存在某些星耀 - 判断指定宫位三方四正是否存在四化 - 判断指定星耀是否存在四化 - 判断指定星耀三方四正是否存在四化 - 判断指定星耀是否是某个亮度 - 根据天干获取四化 - 获取指定星耀所在宫位 - 获取指定宫位三方四正宫位 - 获取指定星耀三方四正宫位 - 获取指定星耀对宫 - 获取指定运限宫位 - 获取指定运限宫位的三方四正 - 判断指定运限宫位内是否存在某些星耀 - 判断指定运限宫位内是否存在四化 - 判断指定运限三方四正内是否存在某些星耀 - 判断指定运限三方四正内是否存在四化 - 判断指定宫位是否是空宫 - 判断宫位是否产生飞星到目标宫位 - 获取宫位产生的四化宫位 - 其他 - 多语言输入/输出输入时支持多个国家和地区语言混合输入，可以输出指定语言。目前支持简体中文、繁体中文、英文、日文、韩文和越南语。英文的翻译目前还没有标准，所以大多是意译的，但也正因为如此，英文版本可能更加易懂。如果有精通星象翻译的欢迎提PR。任何语言都可以。 - 链式调用假如你想判断紫微星的三方四正有没有化忌，你可以这样做 ```ts import { astro } from 'iztro';

const astrolabe = astro.bySolar('2000-8-16', 2, '男', true, 'zh-CN');

astrolabe.star('紫微').surroundedPalaces().haveMutagen('忌');

- 配置和插件  
紫微斗数流派众多，不同流派的四化以及星耀亮度都会有些许差异。为了满足不同流派的需求和功能扩展，iztro在v2.3.0版本加入了全局配置和第三方插件功能。详见[配置文档](https://ziwei.pro/posts/config-n-plugin.html)  
> [!IMPORTANT]
> 如果你在开发中遇到任何问题，可以添加作者微信咨询
> 你也可以任意魔改代码，或联系作者获取技术支持
> <img src="https://github.com/SylarLong/SylarLong/assets/6510425/a2af4876-7d26-4900-a0fc-f5a2030f6205" alt="WeChat" width="350" />  
### 快捷跳转  
- [开发文档](https://docs.iztro.com)
- [讨论](https://github.com/SylarLong/iztro/discussions)
- [问题](https://github.com/SylarLong/iztro/issues)  
### 安装依赖  
你可以使用任何你熟悉的包管理工具来安装`iztro`  
- NPM

npm install iztro -S

- Yarn

yarn add iztro

- pnpm

pnpm install iztro -S

### 独立js库  
如果你使用的是静态`html`文件，可以下载[release](https://github.com/SylarLong/iztro/releases)资源文件中的`iztro-min-js.tar.gz`压缩包，里面包含了一个经过压缩混淆的`iztro`的`js`文件和对应的`sourcemap`文件。  
> `v2.0.4+`版本才提供独立js库。  
将`iztro.min.js`用script标签引入html文件使用。  
```html

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>iztro-紫微斗数开源库</title>
</head>
<body>
<script src="./iztro.min.js"></script>
<script>
// 获取一张星盘数据
var astrolabe = iztro.astro.bySolar('2000-8-16', 2, '男', true, 'zh-CN');
</script>
</body>
</html>

当然，我们更推荐你直接使用CDN加速链接，你可以在下面列表中选择一个，在没有指定版本号的时候，会自动指向最新版本的代码库

jsdelivr
https://cdn.jsdelivr.net/npm/iztro/dist/iztro.min.js
https://cdn.jsdelivr.net/npm/iztro@2.0.5/dist/iztro.min.js
unpkg
https://unpkg.com/iztro/dist/iztro.min.js
https://unpkg.com/iztro@2.0.5/dist/iztro.min.js
你也可以使用如下规则来指定版本：
iztro@2
iztro@^2.0.5
iztro@2.0.5
由于纯JS库没有代码提示和注释，所以在集成时请参阅iztro开发文档

示例

这里是一个简单的例子，展示如何调用iztro获取紫微斗数星盘数据，详细文档请移步开发文档

ES6 Module

import { astro } from 'iztro';

// 通过阳历获取星盘信息
const astrolabe = astro.bySolar('2000-8-16', 2, '女', true, 'zh-CN');

// 通过农历获取星盘信息
const astrolabe = astro.byLunar('2000-7-17', 2, '女', false, true, 'zh-CN');

CommonJS

var iztro = require('iztro');

// 通过阳历获取星盘信息
var astrolabe = iztro.astro.bySolar('2000-8-16', 2, '女', true, 'zh-CN');

// 通过农历获取星盘信息
var astrolabe = iztro.astro.byLunar('2000-7-17', 2, '女', false, true, 'zh-CN');

贡献指南

如果你对iztro感兴趣，也想加入贡献队伍，我们非常欢迎，你可以通过以下方式参与：

如果你对程序功能有什么建议，请到这里创建一个功能需求。
如果你发现程序有BUG，请到这里创建一个BUG报告。
你也可以将本仓库fork到你自己的仓库进行编辑，然后提交PR到本仓库。
如果你擅长外语，我们也欢迎你对国际化文件的翻译做出贡献，你可以fork本仓库，然后在locales文件夹下创建一个国际化语言文件，然后复制其他语言文件目录里面的文件到你的目录下进行更改。
当然，如果你觉得本程序对你有用，请给我买杯咖啡☕️

[!IMPORTANT] 如果你觉得代码对你有用，请点⭐支持，你的⭐是我持续更新的动力

总结

使用本程序返回的数据，你可以生成这样一张星盘，当然这只是一个例子，你可以将注意力集中在星盘的设计上，也可以把重心放在数据的分析上。本程序为你解决了最繁琐的工作，让你可以将精力更多地放在你所需要关注的事情上。
<img width="966" alt="image" src="https://github.com/SylarLong/react-iztro/assets/6510425/f4335997-fdd8-42e2-bb1a-600942f9b0ba">

Star趋势

<a href="https://star-history.com/#sylarlong/iztro&Date"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=sylarlong/iztro&type=Date&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=sylarlong/iztro&type=Date" /> <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=sylarlong/iztro&type=Date" /> </picture> </a> ### [版权](https://github.com/SylarLong/iztro/blob/main/LICENSE) MIT License 版权所有 © 2023 所有贡献者 > [!NOTE] > 请合理使用本开源代码，禁止用于非法目的。 [![FOSSA Status](https://yellow-cdn.veclightyear.com/87312a0a/2663c178-911a-4eb8-ac92-7242